update-notifier
Advanced tools
update-notifier - npm Package Compare versions
Comparing version 7.3.0 to 7.3.1
| { | ||
| "name": "update-notifier", | ||
| "version": "7.3.0", | ||
| "version": "7.3.1", | ||
| "description": "Update notifications for your CLI app", | ||
@@ -41,3 +41,3 @@ "license": "BSD-2-Clause", | ||
| "dependencies": { | ||
| "boxen": "^8.0.0", | ||
| "boxen": "^8.0.1", | ||
| "chalk": "^5.3.0", | ||
@@ -59,3 +59,3 @@ "configstore": "^7.0.0", | ||
| "strip-ansi": "^7.1.0", | ||
| "xo": "^0.59.2" | ||
| "xo": "^0.59.3" | ||
| }, | ||
@@ -62,0 +62,0 @@ "ava": { |
@@ -7,3 +7,3 @@ # update-notifier | ||
| Inform users of your package of updates in a non-intrusive way. | ||
| Inform users of updates for your package in a non-intrusive way. | ||
@@ -27,3 +27,3 @@ #### Contents | ||
| ### Simple | ||
| ### Basic | ||
@@ -37,3 +37,3 @@ ```js | ||
| ### Comprehensive | ||
| ### Advanced | ||
@@ -75,6 +75,6 @@ ```js | ||
| ## How | ||
| ## How it works | ||
| Whenever you initiate the update notifier and it's not within the interval threshold, it will asynchronously check with npm in the background for available updates, then persist the result. The next time the notifier is initiated, the result will be loaded into the `.update` property. This prevents any impact on your package startup performance. | ||
| The update check is done in a unref'ed [child process](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options). This means that if you call `process.exit`, the check will still be performed in its own process. | ||
| The update check is done in an unref'ed [child process](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options). This means that if you call `process.exit`, the check will still be performed in its own process. | ||
@@ -136,3 +136,3 @@ The first time the user runs your app, it will check for an update, and even if an update is available, it will wait the specified `updateCheckInterval` before notifying the user. This is done to not be annoying to the user, but might surprise you as an implementer if you're testing whether it works. Check out [`example.js`](example.js) to quickly test out `update-notifier` and see how you can test that it works in your app. | ||
| - `current` *(string)* - Current version. | ||
| - `type` *(string)* - Type of current update. Possible values: `latest`, `major`, `minor`, `patch`, `prerelease`, `build`. | ||
| - `type` *(string)* - Type of the current update. Possible values: `latest`, `major`, `minor`, `patch`, `prerelease`, `build`. | ||
| - `name` *(string)* - Package name. | ||
@@ -155,3 +155,3 @@ | ||
| Defer showing the notification to after the process has exited. | ||
| Defer showing the notification until after the process has exited. | ||
@@ -209,3 +209,3 @@ ##### message | ||
| There are a bunch projects using it: | ||
| There are a bunch of projects using it: | ||
@@ -218,2 +218,2 @@ - [npm](https://github.com/npm/npm) - Package manager for JavaScript | ||
| [And 2700+ more…](https://www.npmjs.org/browse/depended/update-notifier) | ||
| [And 5000+ more…](https://www.npmjs.org/browse/depended/update-notifier) |
@@ -173,7 +173,2 @@ import process from 'node:process'; | ||
| }); | ||
| process.on('SIGINT', () => { | ||
| console.error(''); | ||
| process.exit(); | ||
| }); | ||
| } | ||
@@ -180,0 +175,0 @@ |
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-0.46%
14845
- Lines of code
- decreased by-2.23%
175
Dependency changes
Updatedboxen@^8.0.1