Class CommandDescriber

Hierarchy

CommandDescriber

Index

Properties

Accessors

Methods

Properties

command

command: CommandConfig = null

Protected help

help: HelpHelper

Protected out

out: OutputHelper

Accessors

Protected config

get config(): HelpHelperOptionsConfig

- Defined in src/helpers/helper.help.ts:300
Returns HelpHelperOptionsConfig

Protected display

get display(): object

- Defined in src/helpers/helper.help.ts:304
Returns object

nl

get nl(): this

- Defined in src/helpers/helper.help.ts:308
Returns this

Methods

arguments

arguments(): this

- Defined in src/helpers/helper.help.ts:344
Returns this

Protected columns

columns(data: any, options?: OutputColumnsOptions): this

- Defined in src/helpers/helper.help.ts:323
Parameters
- data: any
- Default value options: OutputColumnsOptions = {}
Returns this

commands

commands(): this

- Defined in src/helpers/helper.help.ts:381
Returns this

description

description(): this

- Defined in src/helpers/helper.help.ts:425
Returns this

example

example(): this

- Defined in src/helpers/helper.help.ts:436
Returns this

explanation

explanation(): this

- Defined in src/helpers/helper.help.ts:430
Returns this

globalOptions

globalOptions(): this

- Defined in src/helpers/helper.help.ts:415
Returns this

groups

groups(): this

- Defined in src/helpers/helper.help.ts:398
Returns this

line

line(text?: string): this

- Defined in src/helpers/helper.help.ts:318
Parameters
- Default value text: string = ""
Returns this

options

options(): this

- Defined in src/helpers/helper.help.ts:420
Returns this

Protected printOptions

printOptions(options: OptionConfig[]): this

- Defined in src/helpers/helper.help.ts:441
Parameters
- options: OptionConfig[]
Returns this

usage

usage(): this

- Defined in src/helpers/helper.help.ts:327
Returns this

write

write(text: string): this

- Defined in src/helpers/helper.help.ts:313
Parameters
- text: string
Returns this

Generated using TypeDoc