Interface IHelpGeneratorParms

The input parameters to the help generator - the command definition and the tree.

export
interface: IHelpGeneratorParms

Hierarchy

IHelpGeneratorParms

Index

Properties

Properties

commandDefinition

commandDefinition: ICommandDefinition

The command node for the command currently being issued.

memberof: IHelpGeneratorFactoryParms

Optional experimentalCommandsDescription

experimentalCommandsDescription: string

The description text for what "experimental" means in the context of your CLI

memberof: IHelpGeneratorParms

fullCommandTree

fullCommandTree: ICommandDefinition

The entire command tree (which includes the command node for the command being issued)

memberof: IHelpGeneratorFactoryParms

Optional skipTextWrap

skipTextWrap: boolean

The indicator that the given help generator should skip introducing breaks based on terminal width

memberof: IHelpGeneratorParms

Generated using TypeDoc