HelpCommand

Class HelpCommand

Hierarchy

AbstractCommand

↳ HelpCommand

Index

Properties

• cliService

Methods

• output
• renderCommand
• renderExamples
• renderOptions
• renderUsage

---

Properties

Private cliService

cliService: CliService

Defined in Library/Command/HelpCommand.ts:10

---

Methods

output

output(__namedParameters: object, output: Output): Output

Defined in Library/Command/HelpCommand.ts:12

Parameters:

__namedParameters: object

Name	Type
options	any
params	any

output: Output

Returns: Output

---

Private renderCommand

renderCommand(__namedParameters: object): object

Defined in Library/Command/HelpCommand.ts:93

Parameters:

__namedParameters: object

Name	Type
commandLine	string
config	object

Returns: object

---

Private renderExamples

renderExamples(examples: string[]): object

Defined in Library/Command/HelpCommand.ts:86

Parameters:

Name	Type
examples	string[]

Returns: object

---

Private renderOptions

renderOptions(options: CliCommandOptionsType): object

Defined in Library/Command/HelpCommand.ts:70

Parameters:

Name	Type
options	CliCommandOptionsType

Returns: object

---

Private renderUsage

renderUsage(command: CliCommandType): object

Defined in Library/Command/HelpCommand.ts:51

Parameters:

Name	Type
command	CliCommandType

Returns: object

---