Skip to content

doc: add blurb about implications of ABI stability #22508

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
gabrielschulhof wants to merge 3 commits into from
Closed

doc: add blurb about implications of ABI stability #22508

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
75b45a3
doc: add blurb about implications of ABI stability
Aug 24, 2018
78bf7ab
squash! add-on -> addon
Trott Aug 25, 2018
7ba8ae4
squash! address review comments
Aug 27, 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
squash! address review comments
  • Loading branch information
Gabriel Schulhof committed Sep 3, 2018
commit 7ba8ae4cf19c43659e90c0e1040c238f17e75586
13 changes: 5 additions & 8 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,14 @@ example is: [node-addon-api](https://github.com/nodejs/node-addon-api).

Although N-API provides an ABI stability guarantee, other parts of Node.js do
not, and any external libraries used from the addon may not. In particular,
neither of the following Node.js APIs provides an ABI stability guarantee:
none of the following APIs provide an ABI stability guarantee across major
versions:
* the Node.js C++ APIs available via any of
```C++
#include <node.h>
#include <node_buffer.h>
#include <node_context_data.h>
#include <node_contextify.h>
#include <node_mutex.h>
#include <node_object_wrap.h>
#include <node_perf_common.h>
#include <node_platform.h>
#include <node_version.h>
Copy link
Copy Markdown
Member

@addaleax addaleax Aug 24, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only node_buffer.h, node_version.h, node_object_wrap.h and node.h (+ N-API) are real public API. I’ll open a PR to put the others behind NODE_WANT_INTERNALS.

#include <node_object_wrap.h>
```
* the libuv APIs which are also included with Node.js and available via
```C++
Expand All @@ -72,7 +69,7 @@ must make use exclusively of N-API by restricting itself to using
```C
#include <node_api.h>
```
and by checking, for all external library that it uses, that the external
and by checking, for all external libraries that it uses, that the external
library makes ABI stability guarantees similar to N-API.

## Usage
Expand Down