@types/yargs
Advanced tools
Comparing version 15.0.13 to 15.0.14
@@ -644,5 +644,5 @@ // Type definitions for yargs 15.0 | ||
/** Look for command modules in all subdirectories and apply them as a flattened (non-hierarchical) list. */ | ||
recurse?: boolean; | ||
recurse?: boolean | undefined; | ||
/** The types of files to look for when requiring command modules. */ | ||
extensions?: ReadonlyArray<string>; | ||
extensions?: ReadonlyArray<string> | undefined; | ||
/** | ||
@@ -653,7 +653,7 @@ * A synchronous function called for each command module encountered. | ||
*/ | ||
visit?: (commandObject: any, pathToFile?: string, filename?: string) => any; | ||
visit?: ((commandObject: any, pathToFile?: string, filename?: string) => any) | undefined; | ||
/** Whitelist certain modules */ | ||
include?: RegExp | ((pathToFile: string) => boolean); | ||
include?: RegExp | ((pathToFile: string) => boolean) | undefined; | ||
/** Blacklist certain modules. */ | ||
exclude?: RegExp | ((pathToFile: string) => boolean); | ||
exclude?: RegExp | ((pathToFile: string) => boolean) | undefined; | ||
} | ||
@@ -663,23 +663,23 @@ | ||
/** string or array of strings, alias(es) for the canonical option key, see `alias()` */ | ||
alias?: string | ReadonlyArray<string>; | ||
alias?: string | ReadonlyArray<string> | undefined; | ||
/** boolean, interpret option as an array, see `array()` */ | ||
array?: boolean; | ||
array?: boolean | undefined; | ||
/** boolean, interpret option as a boolean flag, see `boolean()` */ | ||
boolean?: boolean; | ||
boolean?: boolean | undefined; | ||
/** value or array of values, limit valid option arguments to a predefined set, see `choices()` */ | ||
choices?: Choices; | ||
choices?: Choices | undefined; | ||
/** function, coerce or transform parsed command line values into another value, see `coerce()` */ | ||
coerce?: (arg: any) => any; | ||
coerce?: ((arg: any) => any) | undefined; | ||
/** boolean, interpret option as a path to a JSON config file, see `config()` */ | ||
config?: boolean; | ||
config?: boolean | undefined; | ||
/** function, provide a custom config parsing function, see `config()` */ | ||
configParser?: (configPath: string) => object; | ||
configParser?: ((configPath: string) => object) | undefined; | ||
/** string or object, require certain keys not to be set, see `conflicts()` */ | ||
conflicts?: string | ReadonlyArray<string> | { [key: string]: string | ReadonlyArray<string> }; | ||
conflicts?: string | ReadonlyArray<string> | { [key: string]: string | ReadonlyArray<string> } | undefined; | ||
/** boolean, interpret option as a count of boolean flags, see `count()` */ | ||
count?: boolean; | ||
count?: boolean | undefined; | ||
/** value, set a default value for the option, see `default()` */ | ||
default?: any; | ||
/** string, use this description for the default value in help content, see `default()` */ | ||
defaultDescription?: string; | ||
defaultDescription?: string | undefined; | ||
/** | ||
@@ -689,29 +689,29 @@ * @deprecated since version 6.6.0 | ||
*/ | ||
demand?: boolean | string; | ||
demand?: boolean | string | undefined; | ||
/** boolean or string, mark the argument as deprecated, see `deprecateOption()` */ | ||
deprecate?: boolean | string; | ||
deprecate?: boolean | string | undefined; | ||
/** boolean or string, mark the argument as deprecated, see `deprecateOption()` */ | ||
deprecated?: boolean | string; | ||
deprecated?: boolean | string | undefined; | ||
/** boolean or string, demand the option be given, with optional error message, see `demandOption()` */ | ||
demandOption?: boolean | string; | ||
demandOption?: boolean | string | undefined; | ||
/** string, the option description for help content, see `describe()` */ | ||
desc?: string; | ||
desc?: string | undefined; | ||
/** string, the option description for help content, see `describe()` */ | ||
describe?: string; | ||
describe?: string | undefined; | ||
/** string, the option description for help content, see `describe()` */ | ||
description?: string; | ||
description?: string | undefined; | ||
/** boolean, indicate that this key should not be reset when a command is invoked, see `global()` */ | ||
global?: boolean; | ||
global?: boolean | undefined; | ||
/** string, when displaying usage instructions place the option under an alternative group heading, see `group()` */ | ||
group?: string; | ||
group?: string | undefined; | ||
/** don't display option in help output. */ | ||
hidden?: boolean; | ||
hidden?: boolean | undefined; | ||
/** string or object, require certain keys to be set, see `implies()` */ | ||
implies?: string | ReadonlyArray<string> | { [key: string]: string | ReadonlyArray<string> }; | ||
implies?: string | ReadonlyArray<string> | { [key: string]: string | ReadonlyArray<string> } | undefined; | ||
/** number, specify how many arguments should be consumed for the option, see `nargs()` */ | ||
nargs?: number; | ||
nargs?: number | undefined; | ||
/** boolean, apply path.normalize() to the option, see `normalize()` */ | ||
normalize?: boolean; | ||
normalize?: boolean | undefined; | ||
/** boolean, interpret option as a number, `number()` */ | ||
number?: boolean; | ||
number?: boolean | undefined; | ||
/** | ||
@@ -721,3 +721,3 @@ * @deprecated since version 6.6.0 | ||
*/ | ||
require?: boolean | string; | ||
require?: boolean | string | undefined; | ||
/** | ||
@@ -727,10 +727,10 @@ * @deprecated since version 6.6.0 | ||
*/ | ||
required?: boolean | string; | ||
required?: boolean | string | undefined; | ||
/** boolean, require the option be specified with a value, see `requiresArg()` */ | ||
requiresArg?: boolean; | ||
requiresArg?: boolean | undefined; | ||
/** boolean, skips validation if the option is present, see `skipValidation()` */ | ||
skipValidation?: boolean; | ||
skipValidation?: boolean | undefined; | ||
/** boolean, interpret option as a string, see `string()` */ | ||
string?: boolean; | ||
type?: "array" | "count" | PositionalOptionsType; | ||
string?: boolean | undefined; | ||
type?: "array" | "count" | PositionalOptionsType | undefined; | ||
} | ||
@@ -740,26 +740,26 @@ | ||
/** string or array of strings, see `alias()` */ | ||
alias?: string | ReadonlyArray<string>; | ||
alias?: string | ReadonlyArray<string> | undefined; | ||
/** boolean, interpret option as an array, see `array()` */ | ||
array?: boolean; | ||
array?: boolean | undefined; | ||
/** value or array of values, limit valid option arguments to a predefined set, see `choices()` */ | ||
choices?: Choices; | ||
choices?: Choices | undefined; | ||
/** function, coerce or transform parsed command line values into another value, see `coerce()` */ | ||
coerce?: (arg: any) => any; | ||
coerce?: ((arg: any) => any) | undefined; | ||
/** string or object, require certain keys not to be set, see `conflicts()` */ | ||
conflicts?: string | ReadonlyArray<string> | { [key: string]: string | ReadonlyArray<string> }; | ||
conflicts?: string | ReadonlyArray<string> | { [key: string]: string | ReadonlyArray<string> } | undefined; | ||
/** value, set a default value for the option, see `default()` */ | ||
default?: any; | ||
/** boolean or string, demand the option be given, with optional error message, see `demandOption()` */ | ||
demandOption?: boolean | string; | ||
demandOption?: boolean | string | undefined; | ||
/** string, the option description for help content, see `describe()` */ | ||
desc?: string; | ||
desc?: string | undefined; | ||
/** string, the option description for help content, see `describe()` */ | ||
describe?: string; | ||
describe?: string | undefined; | ||
/** string, the option description for help content, see `describe()` */ | ||
description?: string; | ||
description?: string | undefined; | ||
/** string or object, require certain keys to be set, see `implies()` */ | ||
implies?: string | ReadonlyArray<string> | { [key: string]: string | ReadonlyArray<string> }; | ||
implies?: string | ReadonlyArray<string> | { [key: string]: string | ReadonlyArray<string> } | undefined; | ||
/** boolean, apply path.normalize() to the option, see normalize() */ | ||
normalize?: boolean; | ||
type?: PositionalOptionsType; | ||
normalize?: boolean | undefined; | ||
type?: PositionalOptionsType | undefined; | ||
} | ||
@@ -819,11 +819,11 @@ | ||
/** array of strings (or a single string) representing aliases of `exports.command`, positional args defined in an alias are ignored */ | ||
aliases?: ReadonlyArray<string> | string; | ||
aliases?: ReadonlyArray<string> | string | undefined; | ||
/** object declaring the options the command accepts, or a function accepting and returning a yargs instance */ | ||
builder?: CommandBuilder<T, U>; | ||
builder?: CommandBuilder<T, U> | undefined; | ||
/** string (or array of strings) that executes this command when given on the command line, first string may contain positional args */ | ||
command?: ReadonlyArray<string> | string; | ||
command?: ReadonlyArray<string> | string | undefined; | ||
/** boolean (or string) to show deprecation notice */ | ||
deprecated?: boolean | string; | ||
deprecated?: boolean | string | undefined; | ||
/** string used as the description for the command in help text, use `false` for a hidden command */ | ||
describe?: string | false; | ||
describe?: string | false | undefined; | ||
/** a function which will be passed the parsed argv. */ | ||
@@ -830,0 +830,0 @@ handler: (args: Arguments<U>) => void; |
{ | ||
"name": "@types/yargs", | ||
"version": "15.0.13", | ||
"version": "15.0.14", | ||
"description": "TypeScript definitions for yargs", | ||
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/yargs", | ||
"license": "MIT", | ||
@@ -59,4 +60,4 @@ "contributors": [ | ||
}, | ||
"typesPublisherContentHash": "9dc5dfe6f64e907144ccb7cbdc31a59a4f0d5408c4fe0c0b1975f64ac7d3b312", | ||
"typeScriptVersion": "3.4" | ||
"typesPublisherContentHash": "08f18db584d12815700691202627482987b3f369093c020e1539deee222b2a09", | ||
"typeScriptVersion": "3.6" | ||
} |
@@ -11,3 +11,3 @@ # Installation | ||
### Additional Details | ||
* Last updated: Fri, 29 Jan 2021 01:21:39 GMT | ||
* Last updated: Fri, 02 Jul 2021 16:32:05 GMT | ||
* Dependencies: [@types/yargs-parser](https://npmjs.com/package/@types/yargs-parser) | ||
@@ -14,0 +14,0 @@ * Global values: none |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
52547
0
0