Interface: ParsedResult<TFlags>
Defined in: packages/parser/src/types.ts:114
The parsed result.
Type Parameters
| Type Parameter | Description |
|---|---|
TFlags extends Record<string, any> | The specific flags type inferred from ParserOptions. |
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
doubleDash | string[] | Arguments after the -- delimiter. | packages/parser/src/types.ts:118 |
flags | TFlags | The parsed flags. This is a strongly-typed object whose structure is inferred from the flags configuration in ParserOptions. | packages/parser/src/types.ts:123 |
ignored | string[] | Arguments that were not parsed due to ignore callback. | packages/parser/src/types.ts:129 |
missingRequiredFlags | string[] | List of required flags that were not provided. | packages/parser/src/types.ts:131 |
parameters | string[] | Positional arguments or commands. | packages/parser/src/types.ts:116 |
raw | string[] | The raw command-line arguments. | packages/parser/src/types.ts:125 |
unknown | Record<string, RawInputType> | Unknown flags encountered during parsing. | packages/parser/src/types.ts:127 |