Skip to content

Interface: ArgToken

Argument token.

Signature

ts
interface ArgToken

Properties

NameTypeDescription
indexnumberArgument token index, e.g --foo bar => --foo index is 0, bar index is 1.
inlineValue (optional)booleanInline value, e.g. --foo=bar => true, -x=bar => true.
kindArgTokenKindArgument token kind.
name (optional)stringOption name, e.g. --foo => foo, -x => x.
rawName (optional)stringRaw option name, e.g. --foo => --foo, -x => -x.
value (optional)stringOption value, e.g. --foo=bar => bar, -x=bar => bar. If the allowCompatible option is true, short option value will be same as Node.js parseArgs behavior.

Released under the MIT License.