Skip to content

doc: better linkaged to node-addon-api #24371

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

Closed
mhdawson wants to merge 4 commits into from
Closed

doc: better linkaged to node-addon-api #24371

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7659fc1
doc: better linkage to node-addon-api
mhdawson Nov 14, 2018
040e4bb
squash: address comments
mhdawson Nov 15, 2018
2b1489b
squash: address comments
mhdawson Nov 15, 2018
c0de9f2
squash: address comments
mhdawson Nov 15, 2018
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
Prev Previous commit
Next Next commit
squash: address comments
  • Loading branch information
@mhdawson
mhdawson authored Nov 15, 2018
commit 2b1489b0743a96a2d25bbd4178b80e03c8f6be42
9 changes: 5 additions & 4 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,16 @@ properties:
handling section [Error Handling][].

The N-API is a C API that ensures ABI stability across Node.js versions
and different compiler levels. A C++ API can be easier to use
. To support using C++, the project maintains a
and different compiler levels. A C++ API can be easier to use.
To support using C++, the project maintains a
C++ wrapper module called
[node-addon-api](https://github.com/nodejs/node-addon-api).
This wrapper provides an inlineable C++ API. Binaries built
with `node-addon-api` will depend on the symbols for the N-API C-based
functions exported by Node.js. `node-addon-api` is a more
efficient way to write code that calls N-API. Take, for example, the
following `node-addon-api` code. The first section shows the
`node-add-api` code and the section section shows what actually gets
`node-addon-api` code and the second section shows what actually gets
used in the addon.

```C++
Expand Down Expand Up @@ -79,7 +79,8 @@ Detailed API documentation for `node-addon-api` is available
[here](https://github.com/nodejs/node-addon-api#api-documentation).


When using `node-addon-api` instead of the C APIs, start with the API docs
When using `node-addon-api` instead of the C APIs, start with the API
[docs](https://github.com/nodejs/node-addon-api#api-documentation)
for `node-addon-api`.
Comment thread
thefourtheye marked this conversation as resolved.

## Implications of ABI Stability
Expand Down