JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 655
  • Score
    100M100P100Q7652F
  • License MIT

Consistent update notifications for packages

Package Exports

  • @zeit/check-updates

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@zeit/check-updates) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

check-updates

This package makes it very easy to implement update notifications into ZEIT packages:

screen shot 2018-01-12 at 15 01 33

Usage

Firstly, install the package:

npm install @zeit/check-updates

Next, initialize it:

const pkg = require('./package')
const updateNotifier = require('@zeit/check-updates')

updateNotifier(pkg, 'Project Name')

You can even pass a millisecond interval for the cache (a day by default):

updateNotifier(pkg, 'Project Name', 80000)

Contributing

  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Link the package to the global module directory: npm link
  3. Within the module you want to test your local development instance of the package, just link it: npm link @zeit/check-updates. Instead of the default one from npm, node will now use your clone.

Author

Leo Lamprecht (@notquiteleo) - ZEIT