ParseArgsConfig interface
Properties
allow |
Whether this command accepts positional arguments. |
args | Array of argument strings. |
options | Used to describe arguments known to the parser. |
strict | Should an error be thrown when unknown arguments are encountered,
or when arguments are passed that do not match the |
tokens | Return the parsed tokens. This is useful for extending the built-in behavior, from adding additional checks through to reprocessing the tokens in different ways. |
Property Details
allowPositionals
Whether this command accepts positional arguments.
allowPositionals?: boolean
Property Value
boolean
args
Array of argument strings.
args?: string[]
Property Value
string[]
options
Used to describe arguments known to the parser.
options?: ParseArgsOptionsConfig
Property Value
ParseArgsOptionsConfig
strict
Should an error be thrown when unknown arguments are encountered,
or when arguments are passed that do not match the type
configured in options
.
strict?: boolean
Property Value
boolean
tokens
Return the parsed tokens. This is useful for extending the built-in behavior, from adding additional checks through to reprocessing the tokens in different ways.
tokens?: boolean
Property Value
boolean