Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@types/yargs-parser) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Installation
npm install --save @types/yargs-parser
Summary
This package contains type definitions for yargs-parser (https://github.com/yargs/yargs-parser#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/yargs-parser/v11.
index.d.ts
declare namespace yargsParser {
interface Arguments {
/** Non-option arguments */
_: string[];
/** The script name or node command */
$0: string;
/** All remaining options */
[argName: string]: any;
}
interface DetailedArguments {
argv: Arguments;
error: Error | null;
aliases: { [alias: string]: string[] };
newAliases: { [alias: string]: boolean };
configuration: Configuration;
}
interface Configuration {
"boolean-negation": boolean;
"camel-case-expansion": boolean;
"combine-arrays": boolean;
"dot-notation": boolean;
"duplicate-arguments-array": boolean;
"flatten-duplicate-arrays": boolean;
"negation-prefix": string;
"parse-numbers": boolean;
"populate--": boolean;
"set-placeholder-key": boolean;
"short-option-groups": boolean;
}
interface Options {
alias?: { [key: string]: string | string[] } | undefined;
array?: string[] | undefined;
boolean?: string[] | undefined;
config?: string | string[] | { [key: string]: boolean } | undefined;
configuration?: Partial<Configuration> | undefined;
coerce?: { [key: string]: (arg: any) => any } | undefined;
count?: string[] | undefined;
default?: { [key: string]: any } | undefined;
envPrefix?: string | undefined;
narg?: { [key: string]: number } | undefined;
normalize?: string[] | undefined;
string?: string[] | undefined;
number?: string[] | undefined;
"--"?: boolean | undefined;
}
interface Parser {
(argv: string | string[], opts?: Options): Arguments;
detailed(argv: string | string[], opts?: Options): DetailedArguments;
}
}
declare var yargsParser: yargsParser.Parser;
export = yargsParser;
Additional Details
- Last updated: Wed, 18 Oct 2023 18:04:04 GMT
- Dependencies: none
Credits
These definitions were written by Miles Johnson.