88 lines
3.1 KiB
Plaintext
88 lines
3.1 KiB
Plaintext
|
/**
|
||
|
|
* Return an argument object populated with the array arguments from args
|
||
|
|
*
|
||
|
|
* @param [args] An optional argument array (typically `process.argv.slice(2)`)
|
||
|
|
* @param [opts] An optional options object to customize the parsing
|
||
|
|
*/
|
||
|
|
declare function minimist(args?: string[], opts?: minimist.Opts): minimist.ParsedArgs;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return an argument object populated with the array arguments from args. Strongly-typed
|
||
|
|
* to be the intersect of type T with minimist.ParsedArgs.
|
||
|
|
*
|
||
|
|
* `T` The type that will be intersected with minimist.ParsedArgs to represent the argument object
|
||
|
|
*
|
||
|
|
* @param [args] An optional argument array (typically `process.argv.slice(2)`)
|
||
|
|
* @param [opts] An optional options object to customize the parsing
|
||
|
|
*/
|
||
|
|
declare function minimist<T>(args?: string[], opts?: minimist.Opts): T & minimist.ParsedArgs;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return an argument object populated with the array arguments from args. Strongly-typed
|
||
|
|
* to be the the type T which should extend minimist.ParsedArgs
|
||
|
|
*
|
||
|
|
* `T` The type that extends minimist.ParsedArgs and represents the argument object
|
||
|
|
*
|
||
|
|
* @param [args] An optional argument array (typically `process.argv.slice(2)`)
|
||
|
|
* @param [opts] An optional options object to customize the parsing
|
||
|
|
*/
|
||
|
|
declare function minimist<T extends minimist.ParsedArgs>(args?: string[], opts?: minimist.Opts): T;
|
||
|
|
|
||
|
|
declare namespace minimist {
|
||
|
|
interface Opts {
|
||
|
|
/**
|
||
|
|
* A string or array of strings argument names to always treat as strings
|
||
|
|
*/
|
||
|
|
string?: string | string[] | undefined;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* A boolean, string or array of strings to always treat as booleans. If true will treat
|
||
|
|
* all double hyphenated arguments without equals signs as boolean (e.g. affects `--foo`, not `-f` or `--foo=bar`)
|
||
|
|
*/
|
||
|
|
boolean?: boolean | string | string[] | undefined;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* An object mapping string names to strings or arrays of string argument names to use as aliases
|
||
|
|
*/
|
||
|
|
alias?: { [key: string]: string | string[] } | undefined;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* An object mapping string argument names to default values
|
||
|
|
*/
|
||
|
|
default?: { [key: string]: any } | undefined;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* When true, populate argv._ with everything after the first non-option
|
||
|
|
*/
|
||
|
|
stopEarly?: boolean | undefined;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* A function which is invoked with a command line parameter not defined in the opts
|
||
|
|
* configuration object. If the function returns false, the unknown option is not added to argv
|
||
|
|
*/
|
||
|
|
unknown?: ((arg: string) => boolean) | undefined;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* When true, populate argv._ with everything before the -- and argv['--'] with everything after the --.
|
||
|
|
* Note that with -- set, parsing for arguments still stops after the `--`.
|
||
|
|
*/
|
||
|
|
"--"?: boolean | undefined;
|
||
|
|
}
|
||
|
|
|
||
|
|
interface ParsedArgs {
|
||
|
|
[arg: string]: any;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If opts['--'] is true, populated with everything after the --
|
||
|
|
*/
|
||
|
|
"--"?: string[] | undefined;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Contains all the arguments that didn't have an option associated with them
|
||
|
|
*/
|
||
|
|
_: string[];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
export = minimist;
|