Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@types/command-line-args
Advanced tools
@types/command-line-args - npm Package Compare versions
Comparing version 4.0.2 to 5.0.0
@@ -1,87 +0,90 @@ | ||
| // Type definitions for command-line-args 4.0.7 | ||
| // Type definitions for command-line-args 5.0 | ||
| // Project: https://github.com/75lb/command-line-args | ||
| // Definitions by: CzBuCHi <https://github.com/CzBuCHi> | ||
| // Definitions by: Lloyd Brookes <https://github.com/75lb> | ||
| // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped | ||
| // TypeScript Version: 2.2 | ||
| /** | ||
| * Returns an object containing all options set on the command line. By default it parses the global [`process.argv`](https://nodejs.org/api/process.html#process_process_argv) array. | ||
| * | ||
| * By default, an exception is thrown if the user sets an unknown option (one without a valid [definition](#exp_module_definition--OptionDefinition)). To enable __partial parsing__, invoke `commandLineArgs` with the `partial` option - all unknown arguments will be returned in the `_unknown` property. | ||
| * | ||
| * | ||
| * @param {module:definition[]} - An array of [OptionDefinition](#exp_module_definition--OptionDefinition) objects | ||
| * @param [options] {object} - Options. | ||
| * @param [options.argv] {string[]} - An array of strings, which if passed will be parsed instead of `process.argv`. | ||
| * @param [options.partial] {boolean} - If `true`, an array of unknown arguments is returned in the `_unknown` property of the output. | ||
| * @returns {object} | ||
| * @throws `UNKNOWN_OPTION` if `options.partial` is false and the user set an undefined option | ||
| * @throws `NAME_MISSING` if an option definition is missing the required `name` property | ||
| * @throws `INVALID_TYPE` if an option definition has a `type` value that's not a function | ||
| * @throws `INVALID_ALIAS` if an alias is numeric, a hyphen or a length other than 1 | ||
| * @throws `DUPLICATE_NAME` if an option definition name was used more than once | ||
| * @throws `DUPLICATE_ALIAS` if an option definition alias was used more than once | ||
| * @throws `DUPLICATE_DEFAULT_OPTION` if more than one option definition has `defaultOption: true` | ||
| * @alias module:command-line-args | ||
| * Returns an object containing option values parsed from the command line. By default it parses the global `process.argv` array. | ||
| * Parsing is strict by default. To be more permissive, enable `partial` or `stopAtFirstUnknown` modes. | ||
| */ | ||
| declare function commandLineArgs(optionDefinitions: commandLineArgs.OptionDefinition[], options?: commandLineArgs.Options): any; | ||
| declare function commandLineArgs(optionDefinitions: commandLineArgs.OptionDefinition[], options?: commandLineArgs.ParseOptions): commandLineArgs.CommandLineOptions; | ||
| declare module commandLineArgs { | ||
| declare namespace commandLineArgs { | ||
| interface CommandLineOptions { | ||
| /** | ||
| * Command-line arguments not parsed by `commandLineArgs`. | ||
| */ | ||
| _unknown?: string[]; | ||
| [propName: string]: any; | ||
| } | ||
| export interface OptionDefinition { | ||
| /** | ||
| * The only required definition property is name, the value of each option will be either a Boolean or string. | ||
| */ | ||
| name: string, | ||
| /** | ||
| * The type value is a setter function (you receive the output from this), | ||
| * enabling you to be specific about the type and value received. | ||
| */ | ||
| type?: (arg: string) => any, | ||
| /** | ||
| * getopt-style short option names. Can be any single character (unicode included) except a digit or hypen. | ||
| */ | ||
| alias?: string, | ||
| /** | ||
| * Set this flag if the option takes a list of values. You will receive an array of values, each passed | ||
| * through the type function (if specified). | ||
| */ | ||
| multiple?: boolean, | ||
| /** | ||
| * Any unclaimed command-line args will be set on this option. This flag is typically set on | ||
| * the most commonly-used option to make for more concise usage | ||
| * (i.e. $ myapp *.js instead of $ myapp --files *.js). | ||
| */ | ||
| defaultOption?: boolean, | ||
| /** | ||
| * An initial value for the option. | ||
| */ | ||
| defaultValue?: any, | ||
| /** | ||
| * When your app has a large amount of options it makes sense to organise them in groups. | ||
| * There are two automatic groups: _all (contains all options) and _none (contains options | ||
| * without a group specified in their definition). | ||
| */ | ||
| group?: string | string[], | ||
| /** | ||
| * Describes the option. | ||
| */ | ||
| description?: string, | ||
| /** | ||
| * A label for the type, e.g. <ms>. | ||
| */ | ||
| typeLabel?: string; | ||
| } | ||
| interface ParseOptions { | ||
| /** | ||
| * An array of strings which if present will be parsed instead of `process.argv`. | ||
| */ | ||
| argv?: string[]; | ||
| export interface Options { | ||
| /** | ||
| * An array of strings, which if passed will be parsed instead of `process.argv`. | ||
| */ | ||
| argv?: string[]; | ||
| /** | ||
| * If `true`, an array of unknown arguments is returned in the `_unknown` property of the output. | ||
| */ | ||
| partial?: boolean; | ||
| } | ||
| /** | ||
| * If `true`, `commandLineArgs` will not throw on unknown options or values, instead returning them in the `_unknown` property of the output. | ||
| */ | ||
| partial?: boolean; | ||
| /** | ||
| * If `true`, `commandLineArgs` will not throw on unknown options or values. Instead, parsing will stop at the first unknown argument | ||
| * and the remaining arguments returned in the `_unknown` property of the output. If set, `partial: true` is implied. | ||
| */ | ||
| stopAtFirstUnknown?: boolean; | ||
| /** | ||
| * If `true`, options with hypenated names (e.g. `move-to`) will be returned in camel-case (e.g. `moveTo`). | ||
| */ | ||
| camelCase?: boolean; | ||
| } | ||
| interface OptionDefinition { | ||
| /** | ||
| * The long option name. | ||
| */ | ||
| name: string; | ||
| /** | ||
| * A setter function (you receive the output from this) enabling you to be specific about the type and value received. Typical values | ||
| * are `String` (the default), `Number` and `Boolean` but you can use a custom function. If no option value was set you will receive `null`. | ||
| */ | ||
| type?: (input: string) => any; | ||
| /** | ||
| * A getopt-style short option name. Can be any single character except a digit or hyphen. | ||
| */ | ||
| alias?: string; | ||
| /** | ||
| * Set this flag if the option accepts multiple values. In the output, you will receive an array of values each passed through the `type` function. | ||
| */ | ||
| multiple?: boolean; | ||
| /** | ||
| * Identical to `multiple` but with greedy parsing disabled. | ||
| */ | ||
| lazyMultiple?: boolean; | ||
| /** | ||
| * Any values unaccounted for by an option definition will be set on the `defaultOption`. This flag is typically set | ||
| * on the most commonly-used option to enable more concise usage. | ||
| */ | ||
| defaultOption?: boolean; | ||
| /** | ||
| * An initial value for the option. | ||
| */ | ||
| defaultValue?: any; | ||
| /** | ||
| * One or more group names the option belongs to. | ||
| */ | ||
| group?: string | string[]; | ||
| } | ||
| } | ||
| export = commandLineArgs; |
| { | ||
| "name": "@types/command-line-args", | ||
| "version": "4.0.2", | ||
| "version": "5.0.0", | ||
| "description": "TypeScript definitions for command-line-args", | ||
@@ -8,5 +8,5 @@ "license": "MIT", | ||
| { | ||
| "name": "CzBuCHi", | ||
| "url": "https://github.com/CzBuCHi", | ||
| "githubUsername": "CzBuCHi" | ||
| "name": "Lloyd Brookes", | ||
| "url": "https://github.com/75lb", | ||
| "githubUsername": "75lb" | ||
| } | ||
@@ -21,4 +21,4 @@ ], | ||
| "dependencies": {}, | ||
| "typesPublisherContentHash": "47b0f898839f3fe8df63f53814c1d04347ce49bbf55dfe5950d4a57f53e35fbb", | ||
| "typeScriptVersion": "2.0" | ||
| "typesPublisherContentHash": "ac83de209d63ac92e03dd17bbadb3e37bbd2552f573bba286ba77e9cfe34dbf6", | ||
| "typeScriptVersion": "2.2" | ||
| } |
@@ -11,3 +11,3 @@ # Installation | ||
| Additional Details | ||
| * Last updated: Thu, 16 Nov 2017 17:18:15 GMT | ||
| * Last updated: Thu, 03 May 2018 20:08:25 GMT | ||
| * Dependencies: none | ||
@@ -17,2 +17,2 @@ * Global values: none | ||
| # Credits | ||
| These definitions were written by CzBuCHi <https://github.com/CzBuCHi>. | ||
| These definitions were written by Lloyd Brookes <https://github.com/75lb>. |
New alerts
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
Fixed alerts
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
Worsened metrics
- Total package byte prevSize
- decreased by-9.59%
5664
- Lines of code
- decreased by-9.64%
75
No dependency changes