You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A set of utilities to assist developers of tools that build [N-API](https://nodejs.org/api/n-api.html#n_api_n_api) native add-ons.
9
+
A set of utilities to assist developers of tools that build [Node-API](https://nodejs.org/api/n-api.html#n_api_n_api) native add-ons.
10
10
11
11
## Background
12
12
13
-
This module is targeted to developers creating tools that build N-API native add-ons.
13
+
This module is targeted to developers creating tools that build Node-API native add-ons.
14
14
15
-
It implements a set of functions that aid in determining the N-API version supported by the currently running Node instance and the set of N-API versions against which the N-API native add-on is designed to be built. Other functions determine whether a particular N-API version can be built and can issue console warnings for unsupported N-API versions.
15
+
It implements a set of functions that aid in determining the Node-API version supported by the currently running Node instance and the set of Node-API versions against which the Node-API native add-on is designed to be built. Other functions determine whether a particular Node-API version can be built and can issue console warnings for unsupported Node-API versions.
16
16
17
17
Unlike the modules this code is designed to facilitate building, this module is written entirely in JavaScript.
18
18
@@ -26,22 +26,22 @@ The module exports a set of functions documented [here](./index.md). For example
26
26
27
27
```javascript
28
28
var napiBuildUtils =require('napi-build-utils');
29
-
var napiVersion =napiBuildUtils.getNapiVersion(); //N-API version supported by Node, or undefined.
29
+
var napiVersion =napiBuildUtils.getNapiVersion(); //Node-API version supported by Node, or undefined.
30
30
```
31
31
32
-
## Declaring supported N-API versions
32
+
## Declaring supported Node-API versions
33
33
34
-
Native modules that are designed to work with [N-API](https://nodejs.org/api/n-api.html#n_api_n_api) must explicitly declare the N-API version(s) against which they are coded to build. This is accomplished by including a `binary.napi_versions` property in the module's `package.json` file. For example:
34
+
Native modules that are designed to work with [Node-API](https://nodejs.org/api/n-api.html#n_api_n_api) must explicitly declare the Node-API version(s) against which they are coded to build. This is accomplished by including a `binary.napi_versions` property in the module's `package.json` file. For example:
35
35
36
36
```json
37
37
"binary": {
38
38
"napi_versions": [2,3]
39
39
}
40
40
```
41
41
42
-
In the absence of a need to compile against a specific N-API version, the value `3` is a good choice as this is the N-API version that was supported when N-API left experimental status.
42
+
In the absence of a need to compile against a specific Node-API version, the value `3` is a good choice as this is the Node-API version that was supported when Node-API left experimental status.
43
43
44
-
Modules that are built against a specific N-API version will continue to operate indefinitely, even as later versions of N-API are introduced.
44
+
Modules that are built against a specific Node-API version will continue to operate indefinitely, even as later versions of Node-API are introduced.
0 commit comments