Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IActionDescription<A, E, R, AV>

Type parameters

Hierarchy

  • IActionDescription

Implemented by

Index

Properties

argumentTypes

argumentTypes: A

flags

flags: {}

Type declaration

Optional type

type: undefined | number

usability

usability: {}

Type declaration

validExecutors

validExecutors: EntityType[]

Methods

clone

  • Returns IActionDescription<A, E, R, AV>

Optional confirmer

  • Called internally during execute

    Parameters

    Returns Promise<boolean>

execute

  • execute(actionApi: IActionApi<E>, ...args: AV): R
  • execute(executor: E, ...args: AV): R
  • Parameters

    Returns R

  • Parameters

    • executor: E
    • Rest ...args: AV

    Returns R

handler

  • Called internally during execute

    Parameters

    Returns R

hasFlag

  • Parameters

    Returns boolean

Optional preExecutionHandler

  • preExecutionHandler(actionApi: IActionApi<E>, ...args: AV): any
  • Called internally during execute

    Parameters

    Returns any

Generated using TypeDoc