ParseArgsConfig interface
Properties
| allow |
If |
| 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
allowNegative
If true, allows explicitly setting boolean options to false by prefixing the option name with --no-.
allowNegative?: booleanProperty Value
boolean
allowPositionals
Whether this command accepts positional arguments.
allowPositionals?: booleanProperty Value
boolean
args
Array of argument strings.
args?: string[]Property Value
string[]
options
Used to describe arguments known to the parser.
options?: ParseArgsOptionsConfigProperty 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?: booleanProperty 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?: booleanProperty Value
boolean