Skip to content

Interface: ParsedResult<TFlags>

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

The parsed result.

Type Parameters

TFlags

TFlags extends Record<string, any>

The specific flags type inferred from ParserOptions.

Properties

doubleDash

ts
doubleDash: string[];

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

Arguments after the -- delimiter.


flags

ts
flags: TFlags;

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

The parsed flags. This is a strongly-typed object whose structure is inferred from the flags configuration in ParserOptions.


ignored

ts
ignored: string[];

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

Arguments that were not parsed due to ignore callback.


parameters

ts
parameters: string[];

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

Positional arguments or commands.


raw

ts
raw: string[];

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

The raw command-line arguments.


unknown

ts
unknown: Record<string, 
RawInputType
>;

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

Unknown flags encountered during parsing.

Released under the MIT license