237899745
b135987fe8
功能新增: - OSS 存储使用情况显示（文件页面） - OSS 当日流量统计（阿里云云监控API） - 分享页面路由修复（/s/xxx 格式支持） Bug修复: - 修复分享页面资源路径（相对路径改绝对路径） - 修复分享码获取逻辑（支持路径格式） - 修复OSS配额undefined显示问题 - 修复登录流程OSS配置检查 - 修复文件数为null时的显示问题 依赖更新: - 添加 @alicloud/cms20190101 云监控SDK - 添加 @alicloud/openapi-client Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
83 lines
2.4 KiB
Markdown
83 lines
2.4 KiB
Markdown
# simple-update-notifier [](https://github.com/alexbrazier/simple-update-notifier/stargazers)
|
|
|
|
[](https://github.com/alexbrazier/simple-update-notifier/actions)
|
|
[](https://www.npmjs.com/package/simple-update-notifier?activeTab=dependencies)
|
|
[](https://www.npmjs.com/package/simple-update-notifier)
|
|
[](https://bundlephobia.com/result?p=simple-update-notifier)
|
|
[](https://www.npmjs.com/package/simple-update-notifier)
|
|
[](./LICENSE)
|
|
|
|
Simple update notifier to check for npm updates for cli applications.
|
|
|
|
<img src="./.github/demo.png" alt="Demo in terminal showing an update is required">
|
|
|
|
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
|
|
|
|
```bash
|
|
npm install simple-update-notifier
|
|
OR
|
|
yarn add simple-update-notifier
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
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](https://docs.npmjs.com/adding-dist-tags-to-packages) 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
|