GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — doc: rename N-API to Node-API · nodejs/node@0eaeaea

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
  • doc
    • api
      • addons.md
      • errors.md
      • index.md
      • n-api.md
    • guides
      • adding-new-napi-api.md
      • collaborator-guide.md
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎doc/api/addons.md‎

Copy file name to clipboardExpand all lines: doc/api/addons.md
+13-12Lines changed: 13 additions & 12 deletions
  • Display the source diff
  • Display the rich diff
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
@@ -243,7 +244,7 @@ changes:
243244
In order to be loaded from multiple Node.js environments,
244245
such as a main thread and a Worker thread, an add-on needs to either:
245246

246-
* Be an N-API addon, or
247+
* Be an Node-API addon, or
247248
* Be declared as context-aware using `NODE_MODULE_INIT()` as described above
248249

249250
In order to support [`Worker`][] threads, addons need to clean up any resources
@@ -435,11 +436,11 @@ addon developers are recommended to use to keep compatibility between past and
435436
future releases of V8 and Node.js. See the `nan` [examples][] for an
436437
illustration of how it can be used.
437438

438-
## N-API
439+
## Node-API
439440

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

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

458-
To use N-API in the above "Hello world" example, replace the content of
459+
To use Node-API in the above "Hello world" example, replace the content of
459460
`hello.cc` with the following. All other instructions remain the same.
460461

461462
```cpp
462-
// hello.cc using N-API
463+
// hello.cc using Node-API
463464
#include <node_api.h>
464465

465466
namespace demo {
@@ -491,7 +492,7 @@ NAPI_MODULE(NODE_GYP_MODULE_NAME, init)
491492
```
492493
493494
The functions available and how to use them are documented in
494-
[C/C++ addons with N-API](n-api.md).
495+
[C/C++ addons with Node-API](n-api.md).
495496
496497
## Addon examples
497498
Collapse file

‎doc/api/errors.md‎

Copy file name to clipboardExpand all lines: doc/api/errors.md
+2-2Lines changed: 2 additions & 2 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -1642,7 +1642,7 @@ would be possible by calling a callback more than once.
16421642
<a id="ERR_NAPI_CONS_FUNCTION"></a>
16431643
### `ERR_NAPI_CONS_FUNCTION`
16441644

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

16471647
<a id="ERR_NAPI_INVALID_DATAVIEW_ARGS"></a>
16481648
### `ERR_NAPI_INVALID_DATAVIEW_ARGS`
@@ -2361,7 +2361,7 @@ added: v9.0.0
23612361
removed: v10.0.0
23622362
-->
23632363

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

23662366
<a id="ERR_NO_LONGER_SUPPORTED"></a>
23672367
### `ERR_NO_LONGER_SUPPORTED`
Collapse file

‎doc/api/index.md‎

Copy file name to clipboardExpand all lines: doc/api/index.md
+1-1Lines changed: 1 addition & 1 deletion
  • Display the source diff
  • Display the rich diff
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 (0)
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.