If there's a new update available, the package will return the content of latest version's package.json file:
const pkg = require('./package');const checkForUpdate = require('update-check');let update = null;try { update = await checkForUpdate(pkg);} catch (err) { console.error(`Failed to check for updates: ${err}`);}if (update) { console.log(`The latest version is ${update.latest}. Please update!`);}
That's it! You're done.
Configuration
If you want, you can also pass options to customize the package's behavior:
const pkg = require('./package');const checkForUpdate = require('update-check');let update = null;try { update = await checkForUpdate(pkg, { interval: 3600000, // For how long to cache latest version (default: 1 day) distTag: 'canary' // A npm distribution tag for comparision (default: 'latest') });} catch (err) { console.error(`Failed to check for updates: ${err}`);}if (update) { console.log(`The latest version is ${update.latest
Contributing
Fork this repository to your own GitHub account and then clone it to your local device
Link the package to the global module directory: npm link
Within the module you want to test your local development instance of the package, just link it: npm link update-check. Instead of the default one from npm, node will now use your clone.