Class MultiCommandCliHelpSubCommand

Implementation of multi-command CLI help available via myCli help or myCli help <command>.

Hierarchy

MultiCommandCliAbstractHelpCommand
- MultiCommandCliHelpSubCommand

Implements

SubCommand

Index

Constructors

constructor

new MultiCommandCliHelpSubCommand(
includeEnvVars: boolean,
commandRegistry: CommandRegistry,
): MultiCommandCliHelpSubCommand
Parameters
- includeEnvVars: boolean
- commandRegistry: CommandRegistry
Returns MultiCommandCliHelpSubCommand
Inherited from MultiCommandCliAbstractHelpCommand.constructor
- Defined in src/command/MultiCommandCliHelpCommand.ts:38

Properties

`Readonly`description

description: "Display application help"

Optional description of the command.

`Readonly`name

name: "help"

Name of the command.

Must consist of alphanumeric non-whitespace ASCII or _ and - characters. Cannot start with -.

`Readonly`options

options: readonly Option[] = []

Option or ComplexOption argument definitions for the sub-command.

`Readonly`positionals

positionals: readonly Positional[] = ...

Positional argument definitions for the sub-command.

Methods

execute

execute(context: Context, argumentValues: ArgumentValues): Promise<void>
Execute the command.
Parameters
- context: Context
  the Context in which to execute the command.
- argumentValues: ArgumentValues
  the argument values for the command. This may be empty if the command's Option and Positional instances are all optional and no argument values were provided.
Returns Promise<void>
Implementation of SubCommand.execute
- Defined in src/command/MultiCommandCliHelpCommand.ts:343

`Protected`printGenericHelp

printGenericHelp(context: Context): Promise<void>
Parameters
- context: Context
Returns Promise<void>
Inherited from MultiCommandCliAbstractHelpCommand.printGenericHelp
- Defined in src/command/MultiCommandCliHelpCommand.ts:167

`Protected`printUsageHelp

printUsageHelp(context: Context, commandName: string): Promise<void>
Parameters
- context: Context
- commandName: string
Returns Promise<void>
Inherited from MultiCommandCliAbstractHelpCommand.printUsageHelp
- Defined in src/command/MultiCommandCliHelpCommand.ts:214

Class MultiCommandCliHelpSubCommand

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MultiCommandCliHelpSubCommand

Properties

`Readonly`description

`Readonly`name

`Readonly`options

`Readonly`positionals

Methods

execute

Parameters

Returns Promise<void>

`Protected`printGenericHelp

Parameters

Returns Promise<void>

`Protected`printUsageHelp

Parameters

Returns Promise<void>

Settings

On This Page

Class MultiCommandCliHelpSubCommand

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MultiCommandCliHelpSubCommand

Properties

Readonlydescription

Readonlyname

Readonlyoptions

Readonlypositionals

Methods

execute

Parameters

Returns Promise<void>

ProtectedprintGenericHelp

Parameters

Returns Promise<void>

ProtectedprintUsageHelp

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`description

`Readonly`name

`Readonly`options

`Readonly`positionals

`Protected`printGenericHelp

`Protected`printUsageHelp