Parser

Classes

Class	Description
InvalidSchemaError	‐

Interfaces

Interface	Description
FlagDefaultValueFunction	‐
ObjectInputType	‐
ParsedResult	The parsed result.
ParserOptions	Configuration options for the parser.
TypeFunction	Defines how a string input is converted to the target type T.

Type Aliases

Type Alias	Description
BaseFlagOptions	‐
FlagDefaultValue	‐
FlagDefinitionValue	‐
FlagOptions	‐
FlagsDefinition	‐
IgnoreFunction	A callback function to conditionally stop parsing. When it returns true, parsing stops and remaining arguments are preserved in `ignored`.
InferFlags	An advanced utility type that infers the exact type of the `flags` object in the parsed result, based on the provided `flags` configuration object T.
RawInputType	‐
TypeValue	‐

Functions

Function	Description
appendDotValues	Similar to setDotValues but handles duplicate keys by converting to arrays. Does NOT apply type conversion - value is set as-is. Useful for flags that can be specified multiple times.
coerceObjectValue	Default value coercion for Object type. Converts "true" / "" to true, "false" to false, other values remain unchanged.
createParser	‐
parse	‐
setDotValues	Sets a value at a nested path in an object, creating intermediate objects as needed. Does NOT apply type conversion - value is set as-is. Overwrites existing values.

References

DOUBLE_DASH

Re-exports DOUBLE_DASH

inferDefault

Re-exports inferDefault

KNOWN_FLAG

Re-exports KNOWN_FLAG

PARAMETER

Re-exports PARAMETER

UNKNOWN_FLAG

Re-exports UNKNOWN_FLAG