Skip to content

Commit ebf3597

Browse files
Gabriel Schulhofdanielleadams
Gabriel Schulhof
authored andcommitted
doc: rename N-API to Node-API
Refs: nodejs/abi-stable-node#420 PR-URL: #37259 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
1 parent d8d851a commit ebf3597

File tree

6 files changed

+178
-177
lines changed

6 files changed

+178
-177
lines changed

doc/api/addons.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,13 @@ _Addons_ are dynamically-linked shared objects written in C++. The
77
[`require()`][require] function can load addons as ordinary Node.js modules.
88
Addons provide an interface between JavaScript and C/C++ libraries.
99

10-
There are three options for implementing addons: N-API, nan, or direct
10+
There are three options for implementing addons: Node-API, nan, or direct
1111
use of internal V8, libuv and Node.js libraries. Unless there is a need for
12-
direct access to functionality which is not exposed by N-API, use N-API.
13-
Refer to [C/C++ addons with N-API](n-api.md) for more information on N-API.
12+
direct access to functionality which is not exposed by Node-API, use Node-API.
13+
Refer to [C/C++ addons with Node-API](n-api.md) for more information on
14+
Node-API.
1415

15-
When not using N-API, implementing addons is complicated,
16+
When not using Node-API, implementing addons is complicated,
1617
involving knowledge of several components and APIs:
1718

1819
* V8: the C++ library Node.js uses to provide the
@@ -245,7 +246,7 @@ changes:
245246
In order to be loaded from multiple Node.js environments,
246247
such as a main thread and a Worker thread, an add-on needs to either:
247248
248-
* Be an N-API addon, or
249+
* Be an Node-API addon, or
249250
* Be declared as context-aware using `NODE_MODULE_INIT()` as described above
250251
251252
In order to support [`Worker`][] threads, addons need to clean up any resources
@@ -437,11 +438,11 @@ addon developers are recommended to use to keep compatibility between past and
437438
future releases of V8 and Node.js. See the `nan` [examples][] for an
438439
illustration of how it can be used.
439440

440-
## N-API
441+
## Node-API
441442

442443
> Stability: 2 - Stable
443444
444-
N-API is an API for building native addons. It is independent from
445+
Node-API is an API for building native addons. It is independent from
445446
the underlying JavaScript runtime (e.g. V8) and is maintained as part of
446447
Node.js itself. This API will be Application Binary Interface (ABI) stable
447448
across versions of Node.js. It is intended to insulate addons from
@@ -451,17 +452,17 @@ recompilation. Addons are built/packaged with the same approach/tools
451452
outlined in this document (node-gyp, etc.). The only difference is the
452453
set of APIs that are used by the native code. Instead of using the V8
453454
or [Native Abstractions for Node.js][] APIs, the functions available
454-
in the N-API are used.
455+
in the Node-API are used.
455456

456457
Creating and maintaining an addon that benefits from the ABI stability
457-
provided by N-API carries with it certain
458+
provided by Node-API carries with it certain
458459
[implementation considerations](n-api.md#n_api_implications_of_abi_stability).
459460

460-
To use N-API in the above "Hello world" example, replace the content of
461+
To use Node-API in the above "Hello world" example, replace the content of
461462
`hello.cc` with the following. All other instructions remain the same.
462463

463464
```cpp
464-
// hello.cc using N-API
465+
// hello.cc using Node-API
465466
#include <node_api.h>
466467

467468
namespace demo {
@@ -493,7 +494,7 @@ NAPI_MODULE(NODE_GYP_MODULE_NAME, init)
493494
```
494495
495496
The functions available and how to use them are documented in
496-
[C/C++ addons with N-API](n-api.md).
497+
[C/C++ addons with Node-API](n-api.md).
497498
498499
## Addon examples
499500

doc/api/errors.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1823,7 +1823,7 @@ would be possible by calling a callback more than once.
18231823
<a id="ERR_NAPI_CONS_FUNCTION"></a>
18241824
### `ERR_NAPI_CONS_FUNCTION`
18251825

1826-
While using `N-API`, a constructor passed was not a function.
1826+
While using `Node-API`, a constructor passed was not a function.
18271827

18281828
<a id="ERR_NAPI_INVALID_DATAVIEW_ARGS"></a>
18291829
### `ERR_NAPI_INVALID_DATAVIEW_ARGS`
@@ -2559,7 +2559,7 @@ added: v9.0.0
25592559
removed: v10.0.0
25602560
-->
25612561

2562-
Used by the `N-API` when `Constructor.prototype` is not an object.
2562+
Used by the `Node-API` when `Constructor.prototype` is not an object.
25632563

25642564
<a id="ERR_NO_LONGER_SUPPORTED"></a>
25652565
### `ERR_NO_LONGER_SUPPORTED`

doc/api/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* [Async hooks](async_hooks.md)
1515
* [Buffer](buffer.md)
1616
* [C++ addons](addons.md)
17-
* [C/C++ addons with N-API](n-api.md)
17+
* [C/C++ addons with Node-API](n-api.md)
1818
* [C++ embedder API](embedding.md)
1919
* [Child processes](child_process.md)
2020
* [Cluster](cluster.md)

0 commit comments

Comments
 (0)