Skip to content

Interface: ParserOptions<T>

Defined in: packages/parser/src/types.ts:92

Configuration options for the parser.

Type Parameters

Type ParameterDefault type

T extends FlagsDefinition

object

Properties

PropertyTypeDescriptionDefined in

delimiters?

string[]

Delimiters to split flag names and values.

Default

ts
["=", ":"];

packages/parser/src/types.ts:105

flags?

T

Detailed configuration for flags. Supports the full object syntax or a type constructor as a shorthand. The key is the flag name (e.g., "file" for "--file").

packages/parser/src/types.ts:98

ignore?

IgnoreFunction

A callback function to conditionally stop parsing. When it returns true, parsing stops and remaining arguments are preserved in ignored.

packages/parser/src/types.ts:111

Released under the MIT license