Skip to content

Interface: ParsedResult<TFlags>

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

The parsed result.

Type Parameters

Type ParameterDescription
TFlags extends Record<string, any>The specific flags type inferred from ParserOptions.

Properties

PropertyTypeDescriptionDefined in
doubleDashstring[]Arguments after the -- delimiter.packages/parser/src/types.ts:118
flagsTFlagsThe parsed flags. This is a strongly-typed object whose structure is inferred from the flags configuration in ParserOptions.packages/parser/src/types.ts:123
ignoredstring[]Arguments that were not parsed due to ignore callback.packages/parser/src/types.ts:129
missingRequiredFlagsstring[]List of required flags that were not provided.packages/parser/src/types.ts:131
parametersstring[]Positional arguments or commands.packages/parser/src/types.ts:116
rawstring[]The raw command-line arguments.packages/parser/src/types.ts:125
unknownRecord<string, RawInputType>Unknown flags encountered during parsing.packages/parser/src/types.ts:127

Released under the MIT license