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

export
interface

  IHelpGeneratorParms

### Hierarchy

- IHelpGeneratorParms

## Index

### Properties

- commandDefinition
- experimentalCommandsDescription
- fullCommandTree
- skipTextWrap

## Properties

### commandDefinition

commandDefinition: ICommandDefinition

- Defined in @zowe/imperative/src/cmd/src/help/doc/IHelpGeneratorParms.ts:24

The command node for the command currently being issued.

memberof

  IHelpGeneratorFactoryParms

### Optional experimentalCommandsDescription

experimentalCommandsDescription: string

- Defined in @zowe/imperative/src/cmd/src/help/doc/IHelpGeneratorParms.ts:36

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

memberof

  IHelpGeneratorParms

### fullCommandTree

fullCommandTree: ICommandDefinition

- Defined in @zowe/imperative/src/cmd/src/help/doc/IHelpGeneratorParms.ts:30

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

memberof

  IHelpGeneratorFactoryParms

### Optional skipTextWrap

skipTextWrap: boolean

- Defined in @zowe/imperative/src/cmd/src/help/doc/IHelpGeneratorParms.ts:42

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

memberof

  IHelpGeneratorParms

Generated using TypeDoc