Interface: ArgToken

Argument token.

Signature

interface ArgToken

Properties

Name	Type	Description
index	number	Argument token index, e.g --foo bar => --foo index is 0, bar index is 1.
inlineValue (optional)	boolean | undefined	Inline value, e.g. --foo=bar => true, -x=bar => true, -x-1 => false, since no = is written. Unlike Node.js parseArgs, false does not mean that the value is the next argument: the value token of -x-1 has the index of that argument.
kind	ArgTokenKind	Argument token kind.
name (optional)	string	Option name, e.g. --foo => foo, -x => x.
rawName (optional)	string	Raw option name, e.g. --foo => --foo, -x => -x.
value (optional)	string | undefined	Option value, e.g. --foo=bar => bar. The value of a short option, such as bar of -x=bar, -1 of -x=-1 or -x-1, and '' of -x=, is in a token of its own after the option, which has no name and rawName. If the allowCompatible option is true, short option value will be same as Node.js parseArgs behavior.