Interface Help

Option help information.

Hierarchy

  • Help

Properties

aliasOf? description? group? help? hidden? usage?

Properties

Optional Readonly aliasOf

aliasOf?: undefined

Optional Readonly description

description?: string

Full option description.

Optional Readonly group

group?: string

The group the option belongs to.

Used when sorting options.

Optional Readonly help

help?: string

Brief help text.

Optional Readonly hidden

hidden?: false

Optional Readonly usage

usage?: string | readonly string[]

Option usage description(s).

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc