Constructors
Methods
parse
parse( __namedParameters: Omit<ArgumentParserConfig, "schema"> & { throwOnError?: boolean; },): Promise< CommonResult< undefined | Pick<ParserGlobalState, "parsedArgs" | "parsedOptions">, > & { errors?: Record<string, [undefined | ErrorType, string]> },> Parameters
- __namedParameters: Omit<ArgumentParserConfig, "schema"> & { throwOnError?: boolean }
Returns Promise<
CommonResult<
undefined
| Pick<ParserGlobalState, "parsedArgs" | "parsedOptions">,
> & { errors?: Record<string, [undefined | ErrorType, string]> },
>
parseArgumentDefinition
parseArgumentDefinition( __namedParameters: CommonArgs< { command: Command; definition: ArgumentParserDefinition; state: ParserGlobalState; }, >,): Promise< CommonResult<{ name: string; value: unknown }> & { abortParsingDefinitions?: boolean; errorTypeForwarded?: ErrorType; },> Returns Promise<
CommonResult<{ name: string; value: unknown }> & {
abortParsingDefinitions?: boolean;
errorTypeForwarded?: ErrorType;
},
>
parseInternal
parseInternal( __namedParameters: Omit<ArgumentParserConfig, "schema">,): Promise< CommonResult< undefined | Pick<ParserGlobalState, "parsedArgs" | "parsedOptions">, > & { errors?: Record<string, [undefined | ErrorType, string]> },> Parameters
- __namedParameters: Omit<ArgumentParserConfig, "schema">
Returns Promise<
CommonResult<
undefined
| Pick<ParserGlobalState, "parsedArgs" | "parsedOptions">,
> & { errors?: Record<string, [undefined | ErrorType, string]> },
>
parseOption
parseOption( __namedParameters: { state: ParserGlobalState } & { context: ArgumentParserContext; schema: ArgumentParserSchema; } & { context: LegacyContext },): CommonResult<void> & { silent?: boolean } Returns CommonResult<void> & { silent?: boolean }
parseOverload
parseOverload( __namedParameters: CommonArgs< { command: Command; defaultState?: ParserGlobalState; overload: ArgumentParserOverload; parsedOptions: Record<string, unknown>; skipIndexes?: number[]; }, >,): Promise< CommonResult<Pick<ParserGlobalState, "parsedArgs" | "parsedOptions">> & { errorTypeForwarded?: ErrorType; },> Parameters
- __namedParameters: CommonArgs<
{
command: Command;
defaultState?: ParserGlobalState;
overload: ArgumentParserOverload;
parsedOptions: Record<string, unknown>;
skipIndexes?: number[];
},
>
Returns Promise<
CommonResult<Pick<ParserGlobalState, "parsedArgs" | "parsedOptions">> & {
errorTypeForwarded?: ErrorType;
},
>
parseType
parseType( __namedParameters: CommonArgs< { command: Command; definition: ArgumentParserDefinition; state: ParserGlobalState; type: ArgumentConstructor<unknown>; typeIndex: number; }, >,): Promise< CommonResult<{ name: string; value: unknown }> & { abortParsingDefinitions?: boolean; },> Returns Promise<
CommonResult<{ name: string; value: unknown }> & {
abortParsingDefinitions?: boolean;
},
>