Class CommandBase

A basic command.

Hierarchy

CommandBase
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand
- EgoCommand

Implements

Command

Index

Properties

Methods

Properties

Abstract description

description: string

A description text.

syntax

syntax: string = "[options]"

Syntax description, which is shown on help screen.

Methods

Abstract execute

execute(context: CommandExecuteContext): Promise<CommandExecuteResult>

- Defined in src/contracts.ts:236
inheritdoc

Parameters
- context: CommandExecuteContext
Returns Promise<CommandExecuteResult>

Abstract showHelp

showHelp(context: CommandShowHelpContext): Promise<CommandShowHelpResult>

- Defined in src/contracts.ts:239
inheritdoc

Parameters
- context: CommandShowHelpContext
Returns Promise<CommandShowHelpResult>

Generated using TypeDoc