burgee
API reference

burgee/commander/extra-typings

burgee/commander/extra-typings is a drop-in for @commander-js/extra-typings: the same API, documented by @commander-js/extra-typings itself. Every name it exports, and where its reference lives.

burgee/commander/extra-typings is a drop-in for @commander-js/extra-typings, graded by the incumbent's own test suite. Its API is the incumbent's, so its reference is the incumbent's own documentation.

  • Reference: @commander-js/extra-typings 15.0.0, the release that suite is run at.
  • How closely it matches: Compatibility, that suite's result in CI, with every case left out of the gate and the reason.
  • Moving a program over: burgee migrate rewrites '@commander-js/extra-typings' to 'burgee/commander/extra-typings' across a project.

Exports

Every name burgee/commander/extra-typings exports, as the built declarations state them. Signatures and behaviour are @commander-js/extra-typings's.

ExportKind
createArgumentfunction
createCommandfunction
createOptionfunction
humanReadableArgNamefunction
useColorfunction
Argumentclass
Commandclass
CommanderErrorclass
DualOptionsclass
Helpclass
InvalidArgumentErrorclass
Optionclass
InvalidOptionArgumentErrorconst
programconst
AddHelpTextContextinterface
BurgeeParseOptionsinterface
CommandOptionsinterface
ErrorOptionsinterface
ExecutableCommandOptionsinterface
HelpContextinterface
OutputConfigurationinterface
OutputContextinterface
ParseOptionsinterface
ParseOptionsResultinterface
AddHelpTextPositiontype
CommandUnknownOptstype
HelpConfigurationtype
HookEventtype
HookListenertype
InferArgumenttype
InferArgumentstype
InferCommandArgumentstype
InferOptionstype
OptionValuestype
OptionValueSourcetype

On this page