node/deps/npm/node_modules/npm-install-checks/README.md
Rebecca Turner 76cb81b354 deps: upgrade npm to 3.6.0
PR-URL: https://github.com/nodejs/node/pull/4958
Reviewed-By: Myles Borins <mborins@us.ibm.com>
Reviewed-By: Kat Marchán <kzm@sykosomatic.org>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2016-02-01 10:43:34 -05:00

630 B

npm-install-checks

A package that contains checks that npm runs during the installation.

API

.checkEngine(target, npmVer, nodeVer, force, strict, cb)

Check if node/npm version is supported by the package. If not strict and it isn't supported, cb is called with the error object as its second argument.

Error type: ENOTSUP

.checkPlatform(target, force, cb)

Check if OS/Arch is supported by the package.

Error type: EBADPLATFORM

.checkCycle(target, ancestors, cb)

Check for cyclic dependencies.

Error type: ECYCLE

.checkGit(folder, cb)

Check if a folder is a .git folder.

Error type: EISGIT