source: trip-planner-front/node_modules/node-gyp-build/README.md@ 76712b2

Last change on this file since 76712b2 was e29cc2e, checked in by Ema <ema_spirova@…>, 3 years ago

primeNG components

  • Property mode set to 100644
File size: 2.4 KB
Line 
1# node-gyp-build
2
3> Build tool and bindings loader for [`node-gyp`][node-gyp] that supports prebuilds.
4
5```
6npm install node-gyp-build
7```
8
9[![Test](https://github.com/prebuild/node-gyp-build/actions/workflows/test.yml/badge.svg)](https://github.com/prebuild/node-gyp-build/actions/workflows/test.yml)
10
11Use together with [`prebuildify`][prebuildify] to easily support prebuilds for your native modules.
12
13## Usage
14
15> **Note.** Prebuild names have changed in [`prebuildify@3`][prebuildify] and `node-gyp-build@4`. Please see the documentation below.
16
17`node-gyp-build` works similar to [`node-gyp build`][node-gyp] except that it will check if a build or prebuild is present before rebuilding your project.
18
19It's main intended use is as an npm install script and bindings loader for native modules that bundle prebuilds using [`prebuildify`][prebuildify].
20
21First add `node-gyp-build` as an install script to your native project
22
23``` js
24{
25 ...
26 "scripts": {
27 "install": "node-gyp-build"
28 }
29}
30```
31
32Then in your `index.js`, instead of using the [`bindings`](https://www.npmjs.com/package/bindings) module use `node-gyp-build` to load your binding.
33
34``` js
35var binding = require('node-gyp-build')(__dirname)
36```
37
38If you do these two things and bundle prebuilds with [`prebuildify`][prebuildify] your native module will work for most platforms
39without having to compile on install time AND will work in both node and electron without the need to recompile between usage.
40
41Users can override `node-gyp-build` and force compiling by doing `npm install --build-from-source`.
42
43Prebuilds will be attempted loaded from `MODULE_PATH/prebuilds/...` and then next `EXEC_PATH/prebuilds/...` (the latter allowing use with `zeit/pkg`)
44
45## Supported prebuild names
46
47If so desired you can bundle more specific flavors, for example `musl` builds to support Alpine, or targeting a numbered ARM architecture version.
48
49These 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`][prebuildify].
50
51Values for the `libc` and `armv` tags are auto-detected but can be overridden through the `LIBC` and `ARM_VERSION` environment variables, respectively.
52
53## License
54
55MIT
56
57[prebuildify]: https://github.com/prebuild/prebuildify
58[node-gyp]: https://www.npmjs.com/package/node-gyp
Note: See TracBrowser for help on using the repository browser.