Interface ICommandHook<STATE, CONTEXT>

A hook that can be passed to a command execute function.

interface ICommandHook<STATE, CONTEXT> {
    beforeExecute?(command, args): boolean | void | Promise<boolean | void>;
    onError?(command, error, args): void;
    onExecute?(command, args): void;
}

Type Parameters

STATE extends any
CONTEXT extends any = void

Index

Methods

beforeExecute? onError? onExecute?

Methods

`Optional` beforeExecute

beforeExecute(command, args): boolean | void | Promise<boolean | void>
If implemented this will be called when execute is called. If a promise is return if will wait until this is completed.
Parameters
- command: ICommand<STATE, CONTEXT>
- args: STATE
Returns boolean | void | Promise<boolean | void>

`Optional` onError

onError(command, error, args): void
Called when a command failed to executed successfully
Parameters
- command: ICommand<STATE, CONTEXT>
- error: any
- args: STATE
Returns void

`Optional` onExecute

onExecute(command, args): void
Called when a command has been executed successful
Parameters
- command: ICommand<STATE, CONTEXT>
- args: STATE
Returns void