Class HelpFormatter`Abstract`

Implements formatting of help messages for a set of option definitions.

Hierarchy (view full)

HelpFormatter

Index

Constructors

Properties

Methods

format sections

Constructors

constructor

new HelpFormatter(validator, config?): HelpFormatter
Creates a help message formatter.
Parameters
- validator: OptionValidator
  The validator instance
- config: FormatterConfig = {}
  The formatter configuration
Returns HelpFormatter
- Defined in packages/tsargp/lib/formatter.ts:724

Properties

`Protected` `Readonly` context

context: HelpContext

Methods

`Abstract` format

format(name?): HelpMessage
Formats the help message of an option group. Options are rendered in the same order as was declared in the option definitions.
Parameters
- Optional name: string
  The group name (defaults to the default group)
Returns HelpMessage
The help message, if the group exists; otherwise an empty message
- Defined in packages/tsargp/lib/formatter.ts:736

`Abstract` sections

sections(sections, progName?): HelpMessage
Formats a help message with sections. Options are rendered in the same order as was declared in the option definitions.
Parameters
- sections: HelpSections
  The help sections
- Optional progName: string
  The program name, if any
Returns HelpMessage
The formatted help message
- Defined in packages/tsargp/lib/formatter.ts:745