Package Exports

npm-update

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 (npm-update) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

npm-update

npm update

Installment

$ npm i npm-update --save

Usage

const update = require('npm-update')
const pkg = require('../package.json')

(async () => {
  const { needUpdate } = await update({ pkg })
  if (needUpdate) return
  // do some stuff
})()

If needUpdate is true, print message:

╭─────────────────────────────────────────╮
│                                         │
│   new version x.y.z found               │
│                                         │
│   run npm i name@x -g                   │
│                                         │
╰─────────────────────────────────────────╯

Options

const {
  needUpdate,               // return true | false
  version: latestVersion,   // return version if needUpdate
} = await update(options)

options {object}
- pkg {object} package.json object.
- host {String} registry host, default is registry.npmjs.org.
- timeout {Number} request registry timeout, default is 3000ms.
- version {String} base version for comparing, can be npm tag or npm version, default is latest.
- silent {Boolean} if slient is true, will not print message, default is false.

Contributors

_xudafeng	_brunoyang	_zhangyuheng

This project follows the git-contributor spec, auto upated at Tue Jun 26 2018 22:22:45 GMT+0800.

License

The MIT License (MIT)