Constructors
Methods
parse
- parse(__namedParameters): 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): Promise<CommonResult<{
name: string;
value: unknown;
}> & {
abortParsingDefinitions?: boolean;
errorTypeForwarded?: ErrorType;
}> Returns Promise<CommonResult<{
name: string;
value: unknown;
}> & {
abortParsingDefinitions?: boolean;
errorTypeForwarded?: ErrorType;
}>
parseInternal
- parseInternal(__namedParameters): 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): CommonResult<void> & {
silent?: boolean;
} Returns CommonResult<void> & {
silent?: boolean;
}
parseOverload
- parseOverload(__namedParameters): Promise<CommonResult<Pick<ParserGlobalState, "parsedArgs" | "parsedOptions">> & {
errorTypeForwarded?: ErrorType;
}> Returns Promise<CommonResult<Pick<ParserGlobalState, "parsedArgs" | "parsedOptions">> & {
errorTypeForwarded?: ErrorType;
}>
parseType
- parseType(__namedParameters): Promise<CommonResult<{
name: string;
value: unknown;
}> & {
abortParsingDefinitions?: boolean;
}> Returns Promise<CommonResult<{
name: string;
value: unknown;
}> & {
abortParsingDefinitions?: boolean;
}>