Captain is currently in ALPHA. We are happy to get your feedback
Core API
Helpers Utils Captain Action

Module: helpers/utils/captain-action

Table of contents

Interfaces

Variables

Functions

Variables

functions

Const functions: FunctionTree

An implementation of the FunctionTree interface to store functions related to user data management. It currently includes a set function for updating user store properties.

Defined in

src/electron/helpers/utils/captain-action.ts:17 (opens in a new tab)

Functions

handleCaptainAction

handleCaptainAction(payload): void

Handles actions directed at the captain entity by invoking functions specified by a function path within the functions tree. The function to be invoked is determined based on the provided functionPath, and it is called with the provided parameters.

Parameters

NameTypeDescription
payloadObjectAn object containing the details of the action to be performed. - id: The path to the function within the functions tree. - parameters: The parameters to be passed to the function.

Returns

void

Defined in

src/electron/helpers/utils/captain-action.ts:37 (opens in a new tab)