Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractHelpGeneratorFactory

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

Implements

Index

Constructors

constructor

Properties

Private mParms

The input parameters to the factory.

memberof

AbstractHelpGeneratorFactory

Private mPrimaryHighlightColor

mPrimaryHighlightColor: string

The primary highlight color - for terminal/console coloring

memberof

AbstractHelpGeneratorFactory

Private mProduceMarkdown

mProduceMarkdown: boolean

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

memberof

AbstractHelpGeneratorFactory

Private mRootCommandName

mRootCommandName: string

The root command name of your CLI

memberof

AbstractHelpGeneratorFactory

Accessors

Protected factoryParameters

Protected primaryHighlightColor

  • get primaryHighlightColor(): string

Protected produceMarkdown

  • get produceMarkdown(): boolean

Protected rootCommandName

  • get rootCommandName(): string

Methods

Protected Abstract getGenerator

getHelpGenerator

Generated using TypeDoc