Skip to content

Commit 05095fc

Browse files
chore(docs): remove rebuilding native addons instructions
1 parent ffc0057 commit 05095fc

2 files changed

Lines changed: 1 addition & 22 deletions

File tree

README.md

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -182,27 +182,6 @@ nwbuild({
182182
});
183183
```
184184

185-
#### Rebuild Node addons
186-
187-
> Currently this feature is disabled and it may be removed in the future.
188-
189-
It only builds node addons which have a `binding.gyp` file in the `srcDir`. There are plans to support nan, cmake, ffi and gn and auto rebuild native addons which are installed as node modules.
190-
191-
```javascript
192-
nwbuild({
193-
mode: "build",
194-
nodeAddon: "gyp",
195-
});
196-
```
197-
198-
We recommend rebuilding Node addons for NW.js via `node-gyp` if you are using NW.js v0.83.0 or above.
199-
200-
```shell
201-
node-gyp rebuild --target=22.2.0 --nodedir=/path/to/nw/node/headers
202-
```
203-
204-
NW.js's Node version should match the Node version on the host machine due to [ABI differences in V8](https://github.com/nwjs/nw.js/issues/5025).
205-
206185
## API Reference
207186

208187
Options

src/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import util from './util.js';
2828
* @property {boolean} [shaSum = true] If true, shasum is enabled. Otherwise, disabled.
2929
* @property {boolean | "zip" | "tar" | "tgz"} [zip=false] If true, "zip", "tar" or "tgz" the outDir directory is compressed.
3030
* @property {boolean | string | object} [managedManifest = false] Managed manifest mode
31-
* @property {boolean} [nodeAddon = false] Rebuild Node native addons
31+
* @property {boolean} [nodeAddon = false] Get Node native addons
3232
* @property {boolean} [cli=false] If true the CLI is used to parse options. This option is used internally.
3333
*/
3434

0 commit comments

Comments
 (0)