GlobalOptionsCommand

Constructors

new GlobalOptionsCommand()

new GlobalOptionsCommand(): GlobalOptionsCommand

Returns

GlobalOptionsCommand

Overrides

BaseCommand.constructor

Properties

Property	Modifier	Type	Inherited from
_completionRules	public	CompletionRules	BaseCommand._completionRules

Methods

add()

add<T, Usage>(
   flags, 
   description, 
   defaultValue): Option

Type Parameters

Type Parameter	Default type
T	‐
Usage extends string	""

Parameters

Parameter	Type
flags	Usage
description	string
defaultValue	T

Returns

Option

---

addOption()

addOption(option): this

Add a prepared Option.

See .option() and .requiredOption() for creating and attaching an option in a single call.

Parameters

Parameter	Type
option	Option

Returns

this

Overrides

BaseCommand.addOption

---

autocomplete()

autocomplete(argv): this

Parameters

Parameter	Type
argv	any

Returns

this

Overrides

BaseCommand.autocomplete

---

autocompleteCandidates()

autocompleteCandidates(typedArgs): any[]

Parameters

Parameter	Type
typedArgs	any[]

Returns

any[]

Inherited from

BaseCommand.autocompleteCandidates

---

autocompleteHandleEvent()

autocompleteHandleEvent(event): void

Parameters

Parameter	Type
event	any

Returns

void

Inherited from

BaseCommand.autocompleteHandleEvent

---

autocompleteNormalizeRules()

autocompleteNormalizeRules(): NormalizedCompletionRules

Returns

NormalizedCompletionRules

Inherited from

BaseCommand.autocompleteNormalizeRules

---

clearOptions()

clearOptions(): this

Returns

this

---

complete()

complete(rules): GlobalOptionsCommand

Parameters

Parameter	Type
rules	CompletionRules & object

Returns

GlobalOptionsCommand

Inherited from

BaseCommand.complete

---

createOption()

createOption(
   flags, 
   description, 
   defaultValue?): Option

Factory routine to create a new unattached option.

See .option() for creating an attached option, which uses this routine to create the option. You can override createOption to return a custom option.

Parameters

Parameter	Type
flags	string
description	string
defaultValue?	any

Returns

Option

Overrides

BaseCommand.createOption

---

getAutocompleteSubCommand()

getAutocompleteSubCommand(
   event, 
   elements, 
   commandName, 
   commandArgs): GlobalOptionsCommand

Parameters

Parameter	Type
event	any
elements	string[]
commandName	string
commandArgs	string[]

Returns

GlobalOptionsCommand

Inherited from

BaseCommand.getAutocompleteSubCommand

---

hasCompletionRules()

hasCompletionRules(): boolean

Returns

boolean

Inherited from

BaseCommand.hasCompletionRules

---

parse()

parse(argv?, parseOptions?): this

Parse argv, setting options and invoking commands when defined.

Use parseAsync instead of parse if any of your action handlers are async.

Call with no parameters to parse process.argv. Detects Electron and special node options like node --eval. Easy mode!

Or call with an array of strings to parse, and optionally where the user arguments start by specifying where the arguments are from:

• 'node': default, argv[0] is the application and argv[1] is the script being run, with user arguments after that
• 'electron': argv[0] is the application and argv[1] varies depending on whether the electron application is packaged
• 'user': just user arguments

Parameters

Parameter	Type
argv?	readonly string[]
parseOptions?	ParseOptions

Returns

this

this command for chaining

Example

program.parse(); // parse process.argv and auto-detect electron and special node flags
program.parse(process.argv); // assume argv[0] is app and argv[1] is script
program.parse(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]

Inherited from

BaseCommand.parse

---

parseAsync()

parseAsync(argv?, parseOptions?): Promise<GlobalOptionsCommand>

Parse argv, setting options and invoking commands when defined.

Call with no parameters to parse process.argv. Detects Electron and special node options like node --eval. Easy mode!

Or call with an array of strings to parse, and optionally where the user arguments start by specifying where the arguments are from:

• 'node': default, argv[0] is the application and argv[1] is the script being run, with user arguments after that
• 'electron': argv[0] is the application and argv[1] varies depending on whether the electron application is packaged
• 'user': just user arguments

Parameters

Parameter	Type
argv?	readonly string[]
parseOptions?	ParseOptions

Returns

Promise<GlobalOptionsCommand>

Promise

Example

await program.parseAsync(); // parse process.argv and auto-detect electron and special node flags
await program.parseAsync(process.argv); // assume argv[0] is app and argv[1] is script
await program.parseAsync(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]

Inherited from

BaseCommand.parseAsync

---

removeOption()

removeOption(option): this

Parameters

Parameter	Type
option	string | Option

Returns

this