Skip to content

shinnn/reject-unsatisfied-npm-version

Repository files navigation

reject-unsatisfied-npm-version

npm version Build Status Coverage Status

Make a Promise rejection unless the currently installed npm CLI satisfies the required version

const rejectUnsatisfiedNpmVersion = require('reject-unsatisfied-npm-version');

// When `npm --version` prints `6.1.0`

(async () => {
  await rejectUnsatisfiedNpmVersion('6.0.0'); // not rejected
  await rejectUnsatisfiedNpmVersion('6.1.0'); // not rejected

  try {
    await rejectUnsatisfiedNpmVersion('6.2.0');
  } catch (err) {
    err.message; //=> 'Expected a version of npm CLI to be 6.2.0 or greater, but an older version 6.1.0 is installed. Run the command `npm install --global npm` to install the latest one.'
    err.code; //=> 'ERR_TOO_OLD_NPM'
  }
})();

Useful for applications and libraries which requires a newer version of npm.

Installation

Use npm.

npm install reject-unsatisfied-npm-version

API

const rejectUnsatisfiedNpmVersion = require('reject-unsatisfied-npm-version');

rejectUnsatisfiedNpmVersion(requiredNpmVersion)

requiredNpmVersion: string (minimum required npm version as a SemVer expression)
Return: Promise

License

ISC License © 2018 Shinnosuke Watanabe

About

Make a Promise rejection unless the currently installed npm CLI satisfies the required version

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published