Bun

interface

util.ParseArgsConfig

interface ParseArgsConfig

  • allowNegative?: boolean

    If true, allows explicitly setting boolean options to false by prefixing the option name with --no-.

  • allowPositionals?: boolean

    Whether this command accepts positional arguments.

  • args?: string[]

    Array of argument strings.

  • options?: ParseArgsOptionsConfig

    Used to describe arguments known to the parser.

  • strict?: boolean

    Should an error be thrown when unknown arguments are encountered, or when arguments are passed that do not match the type configured in options.

  • tokens?: boolean

    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.