Skip to content

Commit 8ed29f5

Browse files
Gabriel Schulhofmhdawson
authored andcommitted
doc: add blurb about ABI stability
PR-URL: #326 Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Nicola Del Gobbo <[email protected]>
1 parent 757eb1f commit 8ed29f5

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,13 @@ provided by N-API. As such, modules built against one version of Node.js
1717
using node-addon-api should run without having to be rebuilt with newer versions
1818
of Node.js.
1919

20+
It is important to remember that *other* Node.js interfaces such as
21+
`libuv` (included in a project via `#include <uv.h>`) are not ABI-stable across
22+
Node.js major versions. Thus, and addon must use N-API and/or `node-addon-api`
23+
exclusively and build against a version of Node.js that includes an
24+
implementation of N-API (meaning a version of Node.js newer than 6.14.2) in
25+
order to benefit from ABI stability across Node.js major versions.
26+
2027
As new APIs are added to N-API, node-addon-api must be updated to provide
2128
wrappers for those new APIs. For this reason node-addon-api provides
2229
methods that allow callers to obtain the underlying N-API handles so

0 commit comments

Comments
 (0)