Parser
Classes
| Class | Description |
|---|---|
| InvalidSchemaError | - |
| MissingRequiredFlagError | - |
Interfaces
| Interface | Description |
|---|---|
| BaseFlagOptions | - |
| ObjectInputType | - |
| ParsedResult | The parsed result. |
| ParserOptions | Configuration options for the parser. |
Type Aliases
| Type Alias | Description |
|---|---|
| FlagDefaultValue | - |
| FlagDefinitionValue | - |
| FlagOptions | - |
| FlagsDefinition | - |
| FlagType | - |
| FlagTypeFunction | Defines how a string input is converted to the target type T. |
| 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 | - |
Functions
| Function | Description | | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------ | --------------------- | | Choices | Creates a Choices type function that validates the input against allowed values. The display name will be formatted as "value1 | value2 | ..." for help output. | | createParser | - | | parse | - |
References
DOUBLE_DASH
Re-exports DOUBLE_DASH
KNOWN_FLAG
Re-exports KNOWN_FLAG
PARAMETER
Re-exports PARAMETER
UNKNOWN_FLAG
Re-exports UNKNOWN_FLAG