mirror of
https://github.com/nodejs/node.git
synced 2025-05-15 11:36:57 +00:00
76cb81b354
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>
28 lines
630 B
Markdown
28 lines
630 B
Markdown
# 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`
|