@types/yargs - npm Package Compare versions

Comparing version 16.0.3 to 16.0.4

yargs v16.0/index.d.ts

@@ -652,5 +652,5 @@ // Type definitions for yargs 16.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;
         /**
@@ -661,7 +661,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;
     }
@@ -671,23 +671,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;
         /**
@@ -697,29 +697,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;
         /**
@@ -729,3 +729,3 @@ *  @deprecated since version 6.6.0
          */
-        require?: boolean | string;
+        require?: boolean | string | undefined;
         /**
@@ -735,10 +735,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;
     }
@@ -748,26 +748,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;
     }
@@ -827,11 +827,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. */
@@ -838,0 +838,0 @@ handler: (args: Arguments<U>) => void;

yargs v16.0/package.json

 {
     "name": "@types/yargs",
-    "version": "16.0.3",
+    "version": "16.0.4",
     "description": "TypeScript definitions for yargs",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/yargs",
     "license": "MIT",
@@ -59,4 +60,4 @@ "contributors": [
     },
-    "typesPublisherContentHash": "1545099833872af2a3d5c4819aaadc45017e9933152ab9cac3124a572174284e",
-    "typeScriptVersion": "3.5"
+    "typesPublisherContentHash": "d46fdfa13e8760d2fb36fecd2e85de1f955504f612121a84f42188b00876dc45",
+    "typeScriptVersion": "3.6"
 }

yargs v16.0/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Fri, 21 May 2021 10:32:05 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

Fixed alerts

Major refactor

Supply chain risk

Package 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

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

53088

increased by1.39%

Number of low quality alerts

0

decreased by-100%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes