Interface Command

A command.

Hierarchy

Command

Index

Properties

Properties

description

description: string

A description text.

execute

execute: (context: CommandExecuteContext) => CommandExecuteResult | PromiseLike<CommandExecuteResult>

Executes the command.

param: The context.
returns: The result.

Type declaration

- (context: CommandExecuteContext): CommandExecuteResult | PromiseLike<CommandExecuteResult>
- Parameters
  - context: CommandExecuteContext
  Returns CommandExecuteResult | PromiseLike<CommandExecuteResult>

showHelp

showHelp: (context: CommandShowHelpContext) => CommandShowHelpResult | PromiseLike<CommandShowHelpResult>

Shows help screen for the command.

param: The context.
returns: The result.

Type declaration

- (context: CommandShowHelpContext): CommandShowHelpResult | PromiseLike<CommandShowHelpResult>
- Parameters
  - context: CommandShowHelpContext
  Returns CommandShowHelpResult | PromiseLike<CommandShowHelpResult>

syntax

syntax: string

Syntax description, which is shown on help screen.

Generated using TypeDoc