The default help generator factory - always supplies the default help generator.

export

### Hierarchy

- AbstractHelpGeneratorFactory
  - HelpGeneratorFactory

### Implements

- IHelpGeneratorFactory

## Index

### Constructors

- constructor

### Accessors

- factoryParameters
- primaryHighlightColor
- produceMarkdown
- rootCommandName

### Methods

- getGenerator
- getHelpGenerator

## Constructors

### constructor

- new HelpGeneratorFactory(parms: IHelpGeneratorFactoryParms): HelpGeneratorFactory

- Inherited from AbstractHelpGeneratorFactory.constructor

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

  Creates an instance of AbstractHelpGeneratorFactory.

  memberof

    AbstractHelpGeneratorFactory

  #### Parameters

  - ##### parms: IHelpGeneratorFactoryParms

    Control parameters and inforamtion required to build help generators

  #### Returns HelpGeneratorFactory

## Accessors

### 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): DefaultHelpGenerator

- Overrides AbstractHelpGeneratorFactory.getGenerator

  - Defined in @zowe/imperative/src/cmd/src/help/HelpGeneratorFactory.ts:29

  Get an instance of the help generator

  memberof

    HelpGeneratorFactory

  #### Parameters

  - ##### parms: IHelpGeneratorParms

    See the interface for details

  #### Returns DefaultHelpGenerator

### 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