https://github.com/npm/npm-install-checks

contains checks that npm runs during the installation
https://github.com/npm/npm-install-checks

npm-cli

Last synced: about 2 months ago
JSON representation

contains checks that npm runs during the installation

• Host: GitHub
• URL: https://github.com/npm/npm-install-checks
• Owner: npm
• License: other
• Created: 2014-01-11T11:39:16.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2024-05-04T00:54:59.000Z (about 2 months ago)
• Last Synced: 2024-05-09T22:11:02.608Z (about 2 months ago)
• Topics: npm-cli
• Language: JavaScript
• Homepage:
• Size: 240 KB
• Stars: 21
• Watchers: 23
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Lists

• awesome-node-utils - npm-install-checks - checks that npm runs during the installation of a module (Uncategorized / Uncategorized)

README

        
# 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 a package's `engines.node` and `engines.npm` match the running system.

`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, environment)

Check if a package's `os`, `cpu` and `libc` match the running system.

`force` argument skips all checks.

`environment` overrides the execution environment which comes from `process.platform` `process.arch` and current `libc` environment by default. `environment.os` `environment.cpu` and `environment.libc` are available.

Error code: 'EBADPLATFORM'