| 1 | # simple-update-notifier [](https://github.com/alexbrazier/simple-update-notifier/stargazers)
|
|---|
| 2 |
|
|---|
| 3 | [](https://github.com/alexbrazier/simple-update-notifier/actions)
|
|---|
| 4 | [](https://www.npmjs.com/package/simple-update-notifier?activeTab=dependencies)
|
|---|
| 5 | [](https://www.npmjs.com/package/simple-update-notifier)
|
|---|
| 6 | [](https://bundlephobia.com/result?p=simple-update-notifier)
|
|---|
| 7 | [](https://www.npmjs.com/package/simple-update-notifier)
|
|---|
| 8 | [](./LICENSE)
|
|---|
| 9 |
|
|---|
| 10 | Simple update notifier to check for npm updates for cli applications.
|
|---|
| 11 |
|
|---|
| 12 | <img src="./.github/demo.png" alt="Demo in terminal showing an update is required">
|
|---|
| 13 |
|
|---|
| 14 | 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.
|
|---|
| 15 |
|
|---|
| 16 | ## Install
|
|---|
| 17 |
|
|---|
| 18 | ```bash
|
|---|
| 19 | npm install simple-update-notifier
|
|---|
| 20 | OR
|
|---|
| 21 | yarn add simple-update-notifier
|
|---|
| 22 | ```
|
|---|
| 23 |
|
|---|
| 24 | ## Usage
|
|---|
| 25 |
|
|---|
| 26 | ```js
|
|---|
| 27 | import updateNotifier from 'simple-update-notifier';
|
|---|
| 28 | import packageJson from './package.json' assert { type: 'json' };
|
|---|
| 29 |
|
|---|
| 30 | updateNotifier({ pkg: packageJson });
|
|---|
| 31 | ```
|
|---|
| 32 |
|
|---|
| 33 | ### Options
|
|---|
| 34 |
|
|---|
| 35 | #### pkg
|
|---|
| 36 |
|
|---|
| 37 | Type: `object`
|
|---|
| 38 |
|
|---|
| 39 | ##### name
|
|---|
| 40 |
|
|---|
| 41 | _Required_\
|
|---|
| 42 | Type: `string`
|
|---|
| 43 |
|
|---|
| 44 | ##### version
|
|---|
| 45 |
|
|---|
| 46 | _Required_\
|
|---|
| 47 | Type: `string`
|
|---|
| 48 |
|
|---|
| 49 | #### updateCheckInterval
|
|---|
| 50 |
|
|---|
| 51 | Type: `number`\
|
|---|
| 52 | Default: `1000 * 60 * 60 * 24` _(1 day)_
|
|---|
| 53 |
|
|---|
| 54 | How often to check for updates.
|
|---|
| 55 |
|
|---|
| 56 | #### shouldNotifyInNpmScript
|
|---|
| 57 |
|
|---|
| 58 | Type: `boolean`\
|
|---|
| 59 | Default: `false`
|
|---|
| 60 |
|
|---|
| 61 | Allows notification to be shown when running as an npm script.
|
|---|
| 62 |
|
|---|
| 63 | #### distTag
|
|---|
| 64 |
|
|---|
| 65 | Type: `string`\
|
|---|
| 66 | Default: `'latest'`
|
|---|
| 67 |
|
|---|
| 68 | Which [dist-tag](https://docs.npmjs.com/adding-dist-tags-to-packages) to use to find the latest version.
|
|---|
| 69 |
|
|---|
| 70 | #### alwaysRun
|
|---|
| 71 |
|
|---|
| 72 | Type: `boolean`\
|
|---|
| 73 | Default: `false`
|
|---|
| 74 |
|
|---|
| 75 | When set, `updateCheckInterval` will not be respected and a check for an update will always be performed.
|
|---|
| 76 |
|
|---|
| 77 | #### debug
|
|---|
| 78 |
|
|---|
| 79 | Type: `boolean`\
|
|---|
| 80 | Default: `false`
|
|---|
| 81 |
|
|---|
| 82 | When set, logs explaining the decision will be output to `stderr` whenever the module opts to not print an update notification
|
|---|
