npm-updater
check npm package update
Last updated 7 months ago by atian25 .
MIT · Repository · Bugs · Original npm · Tarball
$ cnpm install npm-updater 
SYNC missed versions from official npm registry.

npm-updater

NPM version build status Test coverage David deps Known Vulnerabilities npm download

Check update of npm package.

Installation

$ npm i npm-updater --save

Usage

const updater = require('npm-updater');

updater({
  package: require('./package.json'),
  level: 'major',
}).then(result => {
  console.log(result.name, result.version, result.current, result.type);
});

Options

/**
 * check a package lastest version
 * @param {Object} options - query Object
 * @param {Object} options.name - package name, default get from parent package.
 * @param {Object} options.version - package current version, default get from parent package.
 * @param {Object} [options.package] - pass module's `package.json` object
 * @param {String} [options.registry] - publishConfig.registry || npm
 * @param {String} [options.tag] - compare with which tag, default to `latest`.
 * @param {String} [options.interval] - notify interval, default to 1d.
 * @param {Boolean} [options.abort] - If remote version changed, should we abort? default to `true`.
 * @param {String} [options.level] - abort level, default to `minor`.
 * @param {String} [options.updateMessage] - appending update message.
 * @param {Function} [options.formatter] - custom format fn, with args { name, version, current, isAbort, options }.
 * @return {Object} - { name, version, current, type, pkg, options }, type: latest, major, minor, patch, prerelease, build, null
 */

Notice

Please make sure you pacakge's initial version is bigger than 1.0.0.

License

MIT

Downloads
Today 30
This Week 30
This Month 941
Last Day 26
Last Week 302
Last Month 1,485
Dependencies (7)
Dev Dependencies (10)

Copyright 2014 - 2016 © taobao.org |