mage
Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines what user commands may be consisted of

interface

IUserCommand

Hierarchy

  • IUserCommand

Index

Properties

Methods

Properties

Optional acl

acl: string[]

What user levels are allowed to access this user command

Optional timeout

timeout: number

Timeout for the user command

By default, the user command will be allowed to run forever.

Methods

execute

  • execute<T>(state: IState, ...args: any[]): Promise<T>

  • The code of the user command itself

    Type parameters

    • T

    Parameters

    • state: IState
    • Rest ...args: any[]

    Returns Promise<T>