interface ParseArgsConfig
Properties Jump to heading
optional
Jump to headingargs: string[] | undefined
Array of argument strings.
optional
Jump to headingoptions: ParseArgsOptionsConfig | undefined
Used to describe arguments known to the parser.
optional
Jump to headingstrict: boolean | undefined
Should an error be thrown when unknown arguments are encountered,
or when arguments are passed that do not match the type
configured in options
.
optional
Jump to headingallowPositionals: boolean | undefined
Whether this command accepts positional arguments.
optional
Jump to headingallowNegative: boolean | undefined
If true
, allows explicitly setting boolean options to false
by prefixing the option name with --no-
.
optional
Jump to headingtokens: boolean | undefined
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.