npm-update

3.0.1 • Public • Published

npm-update


NPM version build status Test coverage node version npm download

npm update

Installment

$ npm i npm-update --save

Usage

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

(async () => {
  const { needUpdate } = await npmUpdate({ 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


zhangyuheng


brunoyang

This project follows the git-contributor spec, auto updated at Fri Nov 04 2022 13:38:18 GMT+0800.

License

The MIT License (MIT)

Readme

Keywords

Package Sidebar

Install

npm i npm-update

Weekly Downloads

2,523

Version

3.0.1

License

MIT

Unpacked Size

5.59 kB

Total Files

4

Last publish

Collaborators

  • zyhack
  • xudafeng
  • brunoyang