External module "Command"

Index

Enumerations

ReturnValue

Interfaces

Type aliases

Variables

debug

Functions

withState

Type aliases

Argument

Argument: StringArgument | MultiStringArgument | NumericArgument

Handler

Handler: function

Type declaration

- (command: Command, runtimeState: RuntimeState): Promise<ReturnValue | void> | void
- Parameters
  - command: Command
  - runtimeState: RuntimeState
  Returns Promise<ReturnValue | void> | void

Option

Option: BooleanOption | StringOption | NumericOption | MultiStringOption

OptionValue

OptionValue: boolean | string | number | Readonly<string[]> | undefined

OptionsOrArguments

OptionsOrArguments: StoredOptions | StoredArguments

ParsedRuntimeArgs

ParsedRuntimeArgs: IMap<string, Readonly<OptionValue>>

PreProcessor

PreProcessor: function

Type declaration

- (command: Command, runtimeState: RuntimeState): RuntimeState | void
- Parameters
  - command: Command
  - runtimeState: RuntimeState
  Returns RuntimeState | void

RuntimeState

RuntimeState: IMap<string, any>

StoredArguments

StoredArguments: IMap<string, Readonly<Argument>>

StoredOptions

StoredOptions: IMap<string, Readonly<Option>>

SubCommands

SubCommands: IMap<string, Command>

Variables

Const debug

debug: Debugger = Debug("console-commando:Command")

Functions

withState

withState(initialState: CommandState): Command

- Defined in Command.ts:156
Parameters
- initialState: CommandState
Returns Command

Generated using TypeDoc