Home Reference Source Test Repository

Typedef

Static Public Summary
public	Option.Options: Object Options an Option can be created with.
public	Parser.Options: Object Options a Parser can be created with.
public	Parser.ParserOptions: Object Options a Parser uses to parse arguments.

Static Public

public Option.Options: Object source

Options an Option can be created with.

Properties:

Name	Type	Attribute	Description
description	string	optional	A short string describing the option.
type	string	optional default: OptionType.Boolean	The option's type. One of OptionType.
alias	string	optional	The alias to use for the option.

public Parser.Options: Object source

Options a Parser can be created with.

Properties:

Name	Type	Attribute	Description
options	Map<String, Option\|Object\|string>	optional	The options allowed. Any non-Option values will be converted to Options by passing them to Option#constructor directly.
stopParsing	boolean \| string	optional default: false	The string to stop parsing after. Defaults to `--` if set to `true`.

public Parser.ParserOptions: Object source

Options a Parser uses to parse arguments.

Properties:

Name	Type	Attribute	Description
options	Map<String, Option>	optional default: {}	The options allowed.
alias	Map<String, {id: string, opt: Option}>	optional default: {}	The aliases in use.
stopParsing	boolean \| string	optional default: false	The string to stop parsing after or `false`.