2.4 KiB
simple-update-notifier 
Simple update notifier to check for npm updates for cli applications.
Checks for updates for an npm module and outputs to the command line if there is one available. The result is cached for the specified time so it doesn't check every time the app runs.
Install
npm install simple-update-notifier
OR
yarn add simple-update-notifier
Usage
import updateNotifier from 'simple-update-notifier';
import packageJson from './package.json' assert { type: 'json' };
updateNotifier({ pkg: packageJson });
Options
pkg
Type: object
name
Required
Type: string
version
Required
Type: string
updateCheckInterval
Type: number
Default: 1000 * 60 * 60 * 24 (1 day)
How often to check for updates.
shouldNotifyInNpmScript
Type: boolean
Default: false
Allows notification to be shown when running as an npm script.
distTag
Type: string
Default: 'latest'
Which dist-tag to use to find the latest version.
alwaysRun
Type: boolean
Default: false
When set, updateCheckInterval will not be respected and a check for an update will always be performed.
debug
Type: boolean
Default: false
When set, logs explaining the decision will be output to stderr whenever the module opts to not print an update notification