Skip to content

Interface: CommandHelpOptions

Defined in: index.ts:28

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in

examples?

MaybeAsyncGetter<[string, string][]>

Examples to show in the help output. Each example is a tuple of [command, description].

index.ts:37

group?

string

The group this item belongs to. The group must be defined in the groups option of helpPlugin().

HelpOptions.group

index.ts:25

notes?

MaybeAsyncGetter<string[]>

Notes to show in the help output.

index.ts:32

show?

boolean

Whether to show this item in help output.

Default

ts
true;

HelpOptions.show

index.ts:20

Released under the MIT license