npmpackage.info

Gathering detailed insights and metrics for node-gyp-build-optional-packages

Other packages similar to node-gyp-build-optional-packages

node-gyp-build

4.8.4

Build tool and bindings loader for node-gyp that supports prebuilds

node-gyp

10.2.0

Node.js native addon build tool

@npmcli/node-gyp

4.0.0

Tools for dealing with node-gyp packages

@mapbox/node-pre-gyp

1.0.11

Node.js native addon binary install tool

Gathering detailed insights and metrics for node-gyp-build-optional-packages

node-gyp-build-optional-packages

Build tool and bindings loader for node-gyp that supports prebuilds

5.2.2

111

MIT

JavaScript

223,940,477 5.1

Installations

npm install node-gyp-build-optional-packages

Pull Requests

Open

9

Total

44

Closed

6

Merged

29

Issues

Open

19

Total

38

Closed

19

Releases

Unable to fetch releases

Developer

prebuild

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

20.6.0

NPM Version

9.8.1 Statistics

111 Stars

95 Commits

39 Forks

4 Watching

3 Branches

24 Contributors

Updated on 21 Nov 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

223,940,477

Last day

8.8%

837,413

Compared to previous day

Last week

14.9%

4,309,925

Compared to previous week

Last month

19.8%

17,150,476

Compared to previous month

Last year

100.3%

136,223,750

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

detect-libc

Dev Dependencies

array-shuffle standard tape

Versions

node-gyp-build

Build tool and bindings loader for node-gyp that supports prebuilds.

npm install node-gyp-build

Use together with prebuildify to easily support prebuilds for your native modules.

Usage

Note. Prebuild names have changed in prebuildify@3 and node-gyp-build@4. Please see the documentation below.

node-gyp-build works similar to node-gyp build except that it will check if a build or prebuild is present before rebuilding your project.

It's main intended use is as an npm install script and bindings loader for native modules that bundle prebuilds using prebuildify.

First add node-gyp-build as an install script to your native project

1{
2  ...
3  "scripts": {
4    "install": "node-gyp-build"
5  }
6}

Then in your index.js, instead of using the bindings module use node-gyp-build to load your binding.

1var binding = require('node-gyp-build')(__dirname)

If you do these two things and bundle prebuilds with prebuildify your native module will work for most platforms without having to compile on install time AND will work in both node and electron without the need to recompile between usage.

Users can override node-gyp-build and force compiling by doing npm install --build-from-source.

Prebuilds will be attempted loaded from MODULE_PATH/prebuilds/... and then next EXEC_PATH/prebuilds/... (the latter allowing use with zeit/pkg)

Supported prebuild names

If so desired you can bundle more specific flavors, for example musl builds to support Alpine, or targeting a numbered ARM architecture version.

These prebuilds can be bundled in addition to generic prebuilds; node-gyp-build will try to find the most specific flavor first. Prebuild filenames are composed of tags. The runtime tag takes precedence, as does an abi tag over napi. For more details on tags, please see prebuildify.

Values for the libc and armv tags are auto-detected but can be overridden through the LIBC and ARM_VERSION environment variables, respectively.

License

MIT

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

5.1

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More