Class MultiCommandCliHelpGlobalCommand

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

Hierarchy

MultiCommandCliAbstractHelpCommand
- MultiCommandCliHelpGlobalCommand

Implements

GlobalCommand

Index

Constructors

constructor

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

Properties

`Readonly`argument

argument: { isOptional: boolean; name: string; type: ArgumentValueTypeName } = ...

Optional GlobalCommandArgument for the command.

`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`shortAlias

shortAlias: "h"

Optional short alias for the global command.

Must consist of a single alphanumeric non-whitespace ASCII character.

Methods

execute

execute(
context: Context,
argumentValue?: ArgumentSingleValueType,
): Promise<void>
Execute the command.
Parameters
- context: Context
  the Context in which to execute the command.
- OptionalargumentValue: ArgumentSingleValueType
  optional argument value for the command. This will be populated unless the command's GlobalCommandArgument is optional and the argument value was not provided.
Returns Promise<void>
Implementation of GlobalCommand.execute
- Defined in src/command/MultiCommandCliHelpCommand.ts:315

`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 MultiCommandCliHelpGlobalCommand

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MultiCommandCliHelpGlobalCommand

Properties

`Readonly`argument

`Readonly`description

`Readonly`name

`Readonly`shortAlias

Methods

execute

Parameters

Returns Promise<void>

`Protected`printGenericHelp

Parameters

Returns Promise<void>

`Protected`printUsageHelp

Parameters

Returns Promise<void>

Settings

On This Page

Class MultiCommandCliHelpGlobalCommand

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MultiCommandCliHelpGlobalCommand

Properties

Readonlyargument

Readonlydescription

Readonlyname

ReadonlyshortAlias

Methods

execute

Parameters

Returns Promise<void>

ProtectedprintGenericHelp

Parameters

Returns Promise<void>

ProtectedprintUsageHelp

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`argument

`Readonly`description

`Readonly`name

`Readonly`shortAlias

`Protected`printGenericHelp

`Protected`printUsageHelp