@types/yargs - npm Package Compare versions

Comparing version 16.0.2 to 17.0.0

yargs/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for yargs 16.0
+// Type definitions for yargs 17.0
 // Project: https://github.com/chevex/yargs, https://yargs.js.org
@@ -11,2 +11,3 @@ // Definitions by: Martin Poelstra <https://github.com/poelstra>
 //                 Aankhen <https://github.com/Aankhen>
+//                 Ben Coe <https://github.com/bcoe>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -48,3 +49,3 @@ // TypeScript Version: 3.0
     interface Argv<T = {}> {
-        (): { [key in keyof Arguments<T>]: Arguments<T>[key] };
+        (): { [key in keyof Arguments<T>]: Arguments<T>[key] } | Promise<{ [key in keyof Arguments<T>]: Arguments<T>[key] }>;
         (args: ReadonlyArray<string>, cwd?: string): Argv<T>;
@@ -75,3 +76,3 @@
          */
-        argv: { [key in keyof Arguments<T>]: Arguments<T>[key] };
+        argv: { [key in keyof Arguments<T>]: Arguments<T>[key] } | Promise<{ [key in keyof Arguments<T>]: Arguments<T>[key] }>;
 
@@ -338,3 +339,3 @@ /**
          */
-        fail(func: (msg: string, err: Error, yargs: Argv<T>) => any): Argv<T>;
+        fail(func: ((msg: string, err: Error, yargs: Argv<T>) => any) | boolean): Argv<T>;
 
@@ -460,4 +461,9 @@ /**
          */
-        parse(): { [key in keyof Arguments<T>]: Arguments<T>[key] };
-        parse(arg: string | ReadonlyArray<string>, context?: object, parseCallback?: ParseCallback<T>): { [key in keyof Arguments<T>]: Arguments<T>[key] };
+        parse(): { [key in keyof Arguments<T>]: Arguments<T>[key] } | Promise<{ [key in keyof Arguments<T>]: Arguments<T>[key] }>;
+        parse(arg: string | ReadonlyArray<string>, context?: object, parseCallback?: ParseCallback<T>): { [key in keyof Arguments<T>]: Arguments<T>[key] }
+            | Promise<{ [key in keyof Arguments<T>]: Arguments<T>[key] }>;
+        parseSync(): { [key in keyof Arguments<T>]: Arguments<T>[key] };
+        parseSync(arg: string | ReadonlyArray<string>, context?: object, parseCallback?: ParseCallback<T>): { [key in keyof Arguments<T>]: Arguments<T>[key] };
+        parseAsync(): Promise<{ [key in keyof Arguments<T>]: Arguments<T>[key] }>;
+        parseAsync(arg: string | ReadonlyArray<string>, context?: object, parseCallback?: ParseCallback<T>): Promise<{ [key in keyof Arguments<T>]: Arguments<T>[key] }>;
 
@@ -516,8 +522,2 @@ /**
 
-        /**
-         * @deprecated since version 6.6.0
-         * Use '.global()' instead
-         */
-        reset(): Argv<T>;
-
         /** Set the name of your script ($0). Default is the base filename executed by node (`process.argv[1]`) */
@@ -845,3 +845,3 @@ scriptName($0: string): Argv<T>;
 
-    type ParseCallback<T = {}> = (err: Error | undefined, argv: Arguments<T>, output: string) => void;
+    type ParseCallback<T = {}> = (err: Error | undefined, argv: Arguments<T>|Promise<Arguments<T>>, output: string) => void;
     type CommandBuilder<T = {}, U = {}> = { [key: string]: Options } | ((args: Argv<T>) => Argv<U>) | ((args: Argv<T>) => PromiseLike<Argv<U>>);
@@ -848,0 +848,0 @@ type SyncCompletionFunction = (current: string, argv: any) => string[];

yargs/package.json

 {
     "name": "@types/yargs",
-    "version": "16.0.2",
+    "version": "17.0.0",
     "description": "TypeScript definitions for yargs",
@@ -46,2 +46,7 @@ "license": "MIT",
             "githubUsername": "Aankhen"
+        },
+        {
+            "name": "Ben Coe",
+            "url": "https://github.com/bcoe",
+            "githubUsername": "bcoe"
         }
@@ -60,4 +65,4 @@ ],
     },
-    "typesPublisherContentHash": "76606fd40d2d65e82ce39dc28453bc0e8f09daf4aa40f90030bdd8af8cdf068d",
+    "typesPublisherContentHash": "fe3fe339a2118313d9c0674a32f74702649889c130df337b9b11025cf8402e41",
     "typeScriptVersion": "3.5"
 }

yargs/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Tue, 18 May 2021 16:31:45 GMT
+ * Last updated: Fri, 21 May 2021 10:32:05 GMT
  * Dependencies: [@types/yargs-parser](https://npmjs.com/package/@types/yargs-parser)
@@ -17,2 +17,2 @@ * Global values: none
 # Credits
-These definitions were written by [Martin Poelstra](https://github.com/poelstra), [Mizunashi Mana](https://github.com/mizunashi-mana), [Jeffery Grajkowski](https://github.com/pushplay), [Jimi (Dimitris) Charalampidis](https://github.com/JimiC), [Steffen Viken Valvåg](https://github.com/steffenvv), [Emily Marigold Klassen](https://github.com/forivall), [ExE Boss](https://github.com/ExE-Boss), and [Aankhen](https://github.com/Aankhen).
+These definitions were written by [Martin Poelstra](https://github.com/poelstra), [Mizunashi Mana](https://github.com/mizunashi-mana), [Jeffery Grajkowski](https://github.com/pushplay), [Jimi (Dimitris) Charalampidis](https://github.com/JimiC), [Steffen Viken Valvåg](https://github.com/steffenvv), [Emily Marigold Klassen](https://github.com/forivall), [ExE Boss](https://github.com/ExE-Boss), [Aankhen](https://github.com/Aankhen), and [Ben Coe](https://github.com/bcoe).

New alerts

License Policy Violation

License

This 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

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

53313

increased by1.67%

Lines of code

773

increased by0.13%

No dependency changes