Imperative Help generator factory passed to yargs to build help generators where needed.

export

### Hierarchy

- AbstractHelpGeneratorFactory
  - ImperativeHelpGeneratorFactory

### Implements

- IHelpGeneratorFactory

## Index

### Constructors

- constructor

### Properties

- mConfig

### Accessors

- config
- factoryParameters
- primaryHighlightColor
- produceMarkdown
- rootCommandName

### Methods

- getGenerator
- getHelpGenerator

## Constructors

### constructor

- new ImperativeHelpGeneratorFactory(rootCommandName: string, config: IImperativeConfig): ImperativeHelpGeneratorFactory

- Overrides AbstractHelpGeneratorFactory.constructor

  - Defined in @zowe/imperative/src/imperative/src/help/ImperativeHelpGeneratorFactory.ts:30

  Creates an instance of ImperativeHelpGeneratorFactory.

  memberof

    ImperativeHelpGeneratorFactory

  #### Parameters

  - ##### rootCommandName: string

    The root command name of your CLI.

  - ##### config: IImperativeConfig

    The imperative configuration document for your CLI.

  #### Returns ImperativeHelpGeneratorFactory

## Properties

### Private mConfig

mConfig: IImperativeConfig

- Defined in @zowe/imperative/src/imperative/src/help/ImperativeHelpGeneratorFactory.ts:30

The imperative configuration object contains control parameters for the help generator factorys

memberof

  ImperativeHelpGeneratorFactory

## Accessors

### Private config

- get config(): IImperativeConfig

- - Defined in @zowe/imperative/src/imperative/src/help/ImperativeHelpGeneratorFactory.ts:77

  Internal accessor for the configuration object

  readonly
  memberof

    ImperativeHelpGeneratorFactory

  #### Returns IImperativeConfig

### Protected factoryParameters

- get factoryParameters(): IHelpGeneratorFactoryParms

- Inherited from AbstractHelpGeneratorFactory.factoryParameters

  - Defined in @zowe/imperative/src/cmd/src/help/abstract/AbstractHelpGeneratorFactory.ts:137

  Accessor for the full list of parameters

  readonly
  memberof

    AbstractHelpGeneratorFactory

  #### Returns IHelpGeneratorFactoryParms

### Protected primaryHighlightColor

- get primaryHighlightColor(): string

- Inherited from AbstractHelpGeneratorFactory.primaryHighlightColor

  - Defined in @zowe/imperative/src/cmd/src/help/abstract/AbstractHelpGeneratorFactory.ts:115

  Accessor for the primary highlight color

  readonly
  memberof

    AbstractHelpGeneratorFactory

  #### Returns string

### Protected produceMarkdown

- get produceMarkdown(): boolean

- Inherited from AbstractHelpGeneratorFactory.produceMarkdown

  - Defined in @zowe/imperative/src/cmd/src/help/abstract/AbstractHelpGeneratorFactory.ts:126

  Accessor for the produce markdown flag

  readonly
  memberof

    AbstractHelpGeneratorFactory

  #### Returns boolean

### Protected rootCommandName

- get rootCommandName(): string

- Inherited from AbstractHelpGeneratorFactory.rootCommandName

  - Defined in @zowe/imperative/src/cmd/src/help/abstract/AbstractHelpGeneratorFactory.ts:104

  Accessor of the root command nae.

  readonly
  memberof

    AbstractHelpGeneratorFactory

  #### Returns string

## Methods

### Protected getGenerator

- getGenerator(parms: IHelpGeneratorParms): IHelpGenerator

- Overrides AbstractHelpGeneratorFactory.getGenerator

  - Defined in @zowe/imperative/src/imperative/src/help/ImperativeHelpGeneratorFactory.ts:53

  Obtains an instance of the help generator

  memberof

    ImperativeHelpGeneratorFactory

  #### Parameters

  - ##### parms: IHelpGeneratorParms

    See the interface for details

  #### Returns IHelpGenerator

  - The help generator instance

### getHelpGenerator

- getHelpGenerator(parms: IHelpGeneratorParms): IHelpGenerator

- Implementation of IHelpGeneratorFactory.getHelpGenerator

  Inherited from AbstractHelpGeneratorFactory.getHelpGenerator

  - Defined in @zowe/imperative/src/cmd/src/help/abstract/AbstractHelpGeneratorFactory.ts:80

  Verifies the input parameters and returns the help generator instance for the command.

  memberof

    AbstractHelpGeneratorFactory

  #### Parameters

  - ##### parms: IHelpGeneratorParms

    The input parameters - see interface for details.

  #### Returns IHelpGenerator

Generated using TypeDoc