Variable DefaultHelpConfigConst
DefaultHelpConfig: {
argumentDescription: ((this, arg) => string);
argumentTerm: ((this, arg) => string);
commandDescription: ((this, cmd) => string);
commandUsage: ((this, cmd) => string);
formatHelp: ((this, cmd) => string);
helpWidth: undefined;
optionDescription: ((this, opt) => string);
showGlobalOptions: boolean;
sortOptions: boolean;
sortSubcommands: boolean;
subcommandDescription: ((this, cmd) => string);
subcommandTerm: ((this, cmd) => string);
visibleGlobalOptions: ((this, cmd) => Option<"", undefined, undefined, undefined, false, undefined>[]);
visibleOptions: ((this, cmd) => Option<"", undefined, undefined, undefined, false, undefined>[]);
} = ...
Type declaration
-
argumentDescription: ((this, arg) => string)
-
- (this, arg): string
-
Parameters
-
this: Help
-
arg: Argument<"", undefined, undefined, undefined, undefined>
Returns string
-
argumentTerm: ((this, arg) => string)
-
- (this, arg): string
-
Parameters
-
this: Help
-
arg: Argument<"", undefined, undefined, undefined, undefined>
Returns string
-
commandDescription: ((this, cmd) => string)
-
- (this, cmd): string
-
Parameters
-
this: Help
-
cmd: Command<[], {}>
Returns string
-
commandUsage: ((this, cmd) => string)
-
- (this, cmd): string
-
Parameters
-
this: Help
-
cmd: Command<[], {}>
Returns string
-
formatHelp: ((this, cmd) => string)
-
- (this, cmd): string
-
Parameters
-
this: Help
-
cmd: Command<[], {}>
Returns string
-
helpWidth: undefined
-
optionDescription: ((this, opt) => string)
-
- (this, opt): string
-
Parameters
-
this: Help
-
opt: Option<"", undefined, undefined, undefined, false, undefined>
Returns string
-
showGlobalOptions: boolean
-
sortOptions: boolean
-
sortSubcommands: boolean
-
subcommandDescription: ((this, cmd) => string)
-
- (this, cmd): string
-
Parameters
-
this: Help
-
cmd: Command<[], {}>
Returns string
-
subcommandTerm: ((this, cmd) => string)
-
- (this, cmd): string
-
Parameters
-
this: Help
-
cmd: Command<[], {}>
Returns string
-
visibleGlobalOptions: ((this, cmd) => Option<"", undefined, undefined, undefined, false, undefined>[])
-
- (this, cmd): Option<"", undefined, undefined, undefined, false, undefined>[]
-
Parameters
-
this: Help
-
cmd: Command<[], {}>
Returns Option<"", undefined, undefined, undefined, false, undefined>[]
-
visibleOptions: ((this, cmd) => Option<"", undefined, undefined, undefined, false, undefined>[])
-
- (this, cmd): Option<"", undefined, undefined, undefined, false, undefined>[]
-
Parameters
-
this: Help
-
cmd: Command<[], {}>
Returns Option<"", undefined, undefined, undefined, false, undefined>[]