diff options
Diffstat (limited to 'sandbox/testAppNevena/Front/node_modules/npm-install-checks/README.md')
| -rw-r--r-- | sandbox/testAppNevena/Front/node_modules/npm-install-checks/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/sandbox/testAppNevena/Front/node_modules/npm-install-checks/README.md b/sandbox/testAppNevena/Front/node_modules/npm-install-checks/README.md new file mode 100644 index 00000000..e83356c1 --- /dev/null +++ b/sandbox/testAppNevena/Front/node_modules/npm-install-checks/README.md @@ -0,0 +1,27 @@ +# npm-install-checks + +Check the engines and platform fields in package.json + +## API + +Both functions will throw an error if the check fails, or return +`undefined` if everything is ok. + +Errors have a `required` and `current` fields. + +### .checkEngine(pkg, npmVer, nodeVer, force = false) + +Check if node/npm version is supported by the package. If it isn't +supported, an error is thrown. + +`force` argument will override the node version check, but not the npm +version check, as this typically would indicate that the current version of +npm is unable to install the package properly for some reason. + +Error code: 'EBADENGINE' + +### .checkPlatform(pkg, force) + +Check if OS/Arch is supported by the package. + +Error code: 'EBADPLATFORM' |