Class

ActionsManager

ActionsManager

Actions Manager. Access the instance using Actions.

Methods

# static addListener(event, listener) → {EventEmitter}

Add a new listener to the action
Parameters:
Name Type Description
event string Event name
listener function Event callback
Event Emitter
EventEmitter

# static blockAction(action, payloadopt) → {void}

Block action with given payload
Parameters:
Name Type Attributes Description
action string Action
payload ActionsManager.ActionPayload <optional>
 Action payload
void

# static findBlockedActions(action, payloadopt) → {ActionsManager.ActionsWithPayload}

Find blocked actions by action and payload
Parameters:
Name Type Attributes Description
action string | Array.<string> Action or array of actions
payload ActionsManager.MatchActionPayload <optional>
 Payload to search for
ActionsManager.ActionsWithPayload

# static findPendingActions(action, payloadopt) → {ActionsManager.ActionsWithPayload}

Find pending actions by action and payload
Parameters:
Name Type Attributes Description
action string | Array.<string> Action or array of actions
payload ActionsManager.MatchActionPayload <optional>
 Payload to search for
ActionsManager.ActionsWithPayload

# static invokeAction(name, payloadopt) → {Promise.<any>}

Invokes an action
Parameters:
Name Type Attributes Description
name string Name of the action to invoke.
payload ActionsManager.ActionPayload <optional>
 Data to be passed to an action while invoking.
Promise.<any>

# static registerAction(name, action, payloadUpdateFunctionopt) → {void}

Registers an action
Parameters:
Name Type Attributes Description
name string Name of the action to register.
action ActionsManager.ActionFunction A function to execute when the action is invoked.
payloadUpdateFunction ActionsManager.PayloadUpdateFunction <optional>
 A function to update the payload.
void

# static removeAllListeners(event) → {EventEmitter}

Removing all listeners from the action
Parameters:
Name Type Description
event string | symbol Event name
Event Emitter
EventEmitter

# static removeListener(event, listener) → {EventEmitter}

Removing a listener from the action
Parameters:
Name Type Description
event string | symbol Event name
listener function Event callback
Event Emitter
EventEmitter

# static replaceAction(name, action) → {void}

Replace an existing action
Parameters:
Name Type Description
name string An action name to be replaced.
action ActionsManager.ReplacedActionFunction A new function for an action to be replaced.
void

# static unblockAction(action, payloadopt) → {void}

Unblock previously blocked action with given payload.
Parameters:
Name Type Attributes Description
action string Action name
payload ActionsManager.MatchActionPayload <optional>
 Action payload
void

Type Definitions

# ActionCancelFunction() → {void}

void

# ActionFunction(payload) → {Promise.<any>}

Parameters:
Name Type Description
payload ActionsManager.ActionPayload action payload
promise to be invoked for action
Promise.<any>
string

# ActionName

Action name
Object

# ActionPayload

Action payload
Object

# ActionsWithPayload

Actions with payload
Properties:
Name Type Attributes Description
first ActionsManager.ActionWithPayload <optional>
 first action with payload
ACTION_CODE ActionsManager.ActionPayload <optional>
 action payload by action code in key
Object

# ActionWithPayload

Action with payload
Properties:
Name Type Attributes Description
action ActionsManager.ActionName action code
payload ActionsManager.ActionPayload <optional>
 action payload
ActionsManager.MatchActionPayloadPredicate | ActionsManager.ActionPayload

# MatchActionPayload

Action payload or predicate to match

# MatchActionPayloadPredicate(payload, action) → {boolean}

Predicate to match action by payload
Parameters:
Name Type Description
payload ActionsManager.ActionPayload action payload
action string action code
true if payload is matched
boolean

# PayloadUpdateFunction(payload) → {ActionsManager.ActionPayload}

Parameters:
Name Type Description
payload ActionsManager.ActionPayload action payload
updated action payload
ActionsManager.ActionPayload

# ReplacedActionFunction(payload, original) → {Promise.<any>}

Parameters:
Name Type Description
payload ActionsManager.ActionPayload action payload
original ActionsManager.ActionFunction original action invocation
promise to be invoked for action
Promise.<any>

Events

# actionBlockedChanged

Event fired when action blocked status was changed
Parameters:
Name Type Description
blocked boolean whether action was blocked or not
action string action name
payload ActionsManager.ActionPayload action payload

# after[Action]

Event fired after action is invoked
Parameters:
Name Type Description
payload ActionsManager.ActionPayload action payload

# before[Action]

Event fired before action is invoked
Parameters:
Name Type Description
payload ActionsManager.ActionPayload action payload
cancelFunction ActionsManager.ActionCancelFunction function to call to cancel action invocation

# invocationBegin

Event fired before any action invocation

# invocationEnd

Event fired after any action invocation