The abstract help generator factory class - implemented normally by imperative to provide the help generator object that should be used for your CLI.

export
abstract

### Hierarchy

- AbstractHelpGeneratorFactory
  - HelpGeneratorFactory
  - ImperativeHelpGeneratorFactory

### Implements

- IHelpGeneratorFactory

## Index

### Constructors

- constructor

### Properties

- mParms
- mPrimaryHighlightColor
- mProduceMarkdown
- mRootCommandName

### Accessors

- factoryParameters
- primaryHighlightColor
- produceMarkdown
- rootCommandName

### Methods

- getGenerator
- getHelpGenerator

## Constructors

### constructor

- new AbstractHelpGeneratorFactory(parms: IHelpGeneratorFactoryParms): AbstractHelpGeneratorFactory

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

## Properties

### Private mParms

mParms: IHelpGeneratorFactoryParms

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

The input parameters to the factory.

memberof

  AbstractHelpGeneratorFactory

### Private mPrimaryHighlightColor

mPrimaryHighlightColor: string

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

The primary highlight color - for terminal/console coloring

memberof

  AbstractHelpGeneratorFactory

### Private mProduceMarkdown

mProduceMarkdown: boolean

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

True to produce markdown instead of the "normal" help text

memberof

  AbstractHelpGeneratorFactory

### Private mRootCommandName

mRootCommandName: string

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

The root command name of your CLI

memberof

  AbstractHelpGeneratorFactory

## Accessors

### Protected factoryParameters

- get factoryParameters(): IHelpGeneratorFactoryParms

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

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

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

- - 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 Abstract getGenerator

- getGenerator(parms: IHelpGeneratorParms): IHelpGenerator

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

  Implement to return your specific help generator instance.

  abstract
  memberof

    AbstractHelpGeneratorFactory

  #### Parameters

  - ##### parms: IHelpGeneratorParms

  #### Returns IHelpGenerator

  - The help generator for the command.

### getHelpGenerator

- getHelpGenerator(parms: IHelpGeneratorParms): IHelpGenerator

- Implementation of IHelpGeneratorFactory.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