summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/npm-install-checks/README.md
blob: 7da4af1487e1d2a200d9b35f1d9fbd0f20592b2a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# 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.

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`