Skip to content

doc: clarify when to use N-API #849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mhdawson merged 3 commits into from
Dec 9, 2020
Merged

doc: clarify when to use N-API #849

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd1d298
doc: clarify when to use N-API
mhdawson Dec 7, 2020
a019631
squash: address comments
mhdawson Dec 8, 2020
e5eb5e1
squash: address coments
mhdawson Dec 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ the use of the C based [N-API](https://nodejs.org/dist/latest/docs/api/n-api.htm
provided by Node.js when using C++. It provides a C++ object model
and exception handling semantics with low overhead.

There are three options for implementing addons: N-API, nan, or direct
use of internal V8, libuv and Node.js libraries. Unless there is a need for
direct access to functionality which is not exposed by N-API as outlined
in [C/C++ addons](https://nodejs.org/dist/latest/docs/api/addons.html)
in Node.js core, use N-API. Refer to
[C/C++ addons with N-API](https://nodejs.org/dist/latest/docs/api/n-api.html)
for more information on N-API.

N-API is an ABI stable C interface provided by Node.js for building native
addons. It is independent from the underlying JavaScript runtime (e.g. V8 or ChakraCore)
and is maintained as part of Node.js itself. It is intended to insulate
Expand Down