Skip to content

Interface: ParsedResult<TFlags>

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

The parsed result.

Type Parameters

Type ParameterDescription

TFlags extends Record<string, any>

The specific flags type inferred from ParserOptions.

Properties

PropertyTypeDescriptionDefined in

doubleDash

string[]

Arguments after the -- delimiter.

packages/parser/src/types.ts:132

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:137

ignored

string[]

Arguments that were not parsed due to ignore callback.

packages/parser/src/types.ts:153

missingRequiredFlags

string[]

List of required flags that were not provided.

packages/parser/src/types.ts:157

parameters

string[]

Positional arguments or commands.

packages/parser/src/types.ts:128

raw

string[]

The raw command-line arguments.

packages/parser/src/types.ts:141

rawUnknown

string[]

Raw arguments for unknown flags (original string form).

packages/parser/src/types.ts:149

unknown

Record<string, RawInputType>

Unknown flags encountered during parsing.

packages/parser/src/types.ts:145

在 MIT 许可证下发布