Class HelpHelper

Hierarchy

HelpHelper

Index

Properties

Accessors

getSubCommands

Methods

Properties

cli

cli: Cli

config

config: HelpHelperOptionsConfig

events

events: Dispatcher

log

log: Log

out

out: OutputHelper

Accessors

getSubCommands

get getSubCommands(): SubCommandsGetFunction

- Defined in src/helpers/helper.help.ts:177
Returns SubCommandsGetFunction

Methods

createDescriber

createDescriber(command: CommandConfig): CommandDescriber

- Defined in src/helpers/helper.help.ts:171
Parameters
- command: CommandConfig
Returns CommandDescriber

getSubcommandsNameTree

getSubcommandsNameTree(config: CommandConfig): any

- Defined in src/helpers/helper.help.ts:217
Parameters
- config: CommandConfig
Returns any

Protected getTreeSubcommands

getTreeSubcommands(config: CommandConfig): any[]

- Defined in src/helpers/helper.help.ts:199
Parameters
- config: CommandConfig
Returns any[]

onCommandHandle

onCommandHandle(event: CliExecuteCommandHandleEvent): void

- Defined in src/helpers/helper.help.ts:250
Parameters
- event: CliExecuteCommandHandleEvent
Returns void

onCommandParse

onCommandParse(event: CliExecuteCommandParseEvent): void

- Defined in src/helpers/helper.help.ts:239
Parameters
- event: CliExecuteCommandParseEvent
Returns void

onInvalidArguments

onInvalidArguments(event: CliExecuteCommandInvalidArgumentsEvent): any

- Defined in src/helpers/helper.help.ts:268
Parameters
- event: CliExecuteCommandInvalidArgumentsEvent
Returns any

printCommandTree

printCommandTree(label?: string, config?: CommandConfig): void

- Defined in src/helpers/helper.help.ts:194
Parameters
- Default value label: string = "Command tree:"
- Optional config: CommandConfig
Returns void

showHelp

showHelp(config: CommandConfig, options: OptionConfig[]): Promise<void>

- Defined in src/helpers/helper.help.ts:180
Parameters
- config: CommandConfig
- options: OptionConfig[]
Returns Promise<void>

Generated using TypeDoc