@types/update-notifier - npm Package Compare versions

Comparing version 2.5.0 to 4.1.0

update-notifier/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for update-notifier 2.5
+// Type definitions for update-notifier 4.1
 // Project: https://github.com/yeoman/update-notifier
@@ -7,9 +7,11 @@ // Definitions by: vvakame <https://github.com/vvakame>
 //                 Michael Grinich <https://github.com/grinich>
+//                 Piotr Błażejewicz <https://github.com/peterblazejewicz>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
+import ConfigStore = require('configstore');
+
 export = UpdateNotifier;
 
-declare function UpdateNotifier(
-    settings?: UpdateNotifier.Settings
-): UpdateNotifier.UpdateNotifier;
+/** Checks if there is an available update */
+declare function UpdateNotifier(settings?: UpdateNotifier.Settings): UpdateNotifier.UpdateNotifier;
 
@@ -20,5 +22,8 @@ declare namespace UpdateNotifier {
 
-        update?: UpdateInfo;
+        readonly config: ConfigStore;
+        readonly update?: UpdateInfo;
         check(): void;
-        checkNpm(): void;
+        /** Check update information */
+        fetchInfo(): UpdateInfo | Promise<UpdateInfo>;
+        /** Convenience method to display a notification message */
         notify(customMessage?: NotifyOptions): void;
@@ -28,7 +33,16 @@ }
     interface Settings {
+        /** Which dist-tag to use to find the latest version */
+        distTag?: string;
         pkg?: Package;
-        callback?(error: Error | null, update?: UpdateInfo): any;
+        /**
+         * @deprecated use `pkg.name`
+         */
         packageName?: string;
+        /**
+         * @deprecated use `pkg.version`
+         */
         packageVersion?: string;
-        updateCheckInterval?: number; // in milliseconds, default 1000 * 60 * 60 * 24 (1 day)
+        /** How often to check for updates */
+        updateCheckInterval?: number;
+        /** Allows notification to be shown when running as an npm script */
         shouldNotifyInNpmScript?: boolean;
@@ -46,6 +60,10 @@ }
     interface NotifyOptions {
+        /** Message that will be shown when an update is available */
         message?: string;
+        /** Defer showing the notification to after the process has exited */
         defer?: boolean;
+        /** Include the -g argument in the default message's npm i recommendation */
         isGlobal?: boolean;
-        boxenOpts?: BoxenOptions;
+        /** Options object that will be passed to `boxen` */
+        boxenOptions?: BoxenOptions;
     }
@@ -59,7 +77,11 @@
     interface UpdateInfo {
-        latest: string;
-        current: string;
-        type: string;
+        /** Latest version */
+        readonly latest: string;
+        /** Current version */
+        readonly current: string;
+        /** Type of current update */
+        readonly type: 'latest' | 'major' | 'minor' | 'patch' | 'prerelease' | 'build';
+        /** Package name */
         name: string;
     }
 }

update-notifier/package.json

 {
     "name": "@types/update-notifier",
-    "version": "2.5.0",
+    "version": "4.1.0",
     "description": "TypeScript definitions for update-notifier",
@@ -26,14 +26,22 @@ "license": "MIT",
             "githubUsername": "grinich"
+        },
+        {
+            "name": "Piotr Błażejewicz",
+            "url": "https://github.com/peterblazejewicz",
+            "githubUsername": "peterblazejewicz"
         }
     ],
     "main": "",
-    "types": "",
+    "types": "index.d.ts",
     "repository": {
         "type": "git",
-        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git"
+        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
+        "directory": "types/update-notifier"
     },
     "scripts": {},
-    "dependencies": {},
-    "typesPublisherContentHash": "55e6f87e2f5c26c35411e9bde400792f216f916d6d85d68bf6a58a8ea13b1456",
-    "typeScriptVersion": "2.0"
+    "dependencies": {
+        "@types/configstore": "*"
+    },
+    "typesPublisherContentHash": "19bc325bfe4a186a4d9540c7aca28d30775c2f30bd095a3fed9c23133da967ab",
+    "typeScriptVersion": "2.8"
 }

update-notifier/README.md

@@ -8,10 +8,10 @@ # Installation
 # Details
-Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/update-notifier
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/update-notifier.
 
-Additional Details
- * Last updated: Sat, 27 Oct 2018 01:45:33 GMT
- * Dependencies: none
+### Additional Details
+ * Last updated: Sat, 22 Feb 2020 02:24:26 GMT
+ * Dependencies: [@types/configstore](https://npmjs.com/package/@types/configstore)
  * Global values: none
 
 # Credits
-These definitions were written by vvakame <https://github.com/vvakame>, Noah Chen <https://github.com/nchen63>, Jason Dreyzehner <https://github.com/bitjson>, Michael Grinich <https://github.com/grinich>.
+These definitions were written by [vvakame](https://github.com/vvakame), [Noah Chen](https://github.com/nchen63), [Jason Dreyzehner](https://github.com/bitjson), [Michael Grinich](https://github.com/grinich), and [Piotr Błażejewicz](https://github.com/peterblazejewicz).

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

6024

increased by32.4%

Lines of code

72

increased by41.18%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Added@types/configstore@*

• + Added@types/configstore@6.0.2(transitive)