Skip to content

Commit fd65078

Browse files
author
Gabriel Schulhof
committed
README.md: link to new ABI stability guide
Re: nodejs/abi-stable-node#332 PR-URL: #367 Reviewed-By: Nicola Del Gobbo <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
1 parent ffebf9b commit fd65078

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,12 @@ of Node.js.
1919

2020
It is important to remember that *other* Node.js interfaces such as
2121
`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`
22+
Node.js major versions. Thus, an addon must use N-API and/or `node-addon-api`
2323
exclusively and build against a version of Node.js that includes an
2424
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.
25+
order to benefit from ABI stability across Node.js major versions. Node.js
26+
provides an [ABI stability guide][] containing a detailed explanation of ABI
27+
stability in general, and the N-API ABI stability guarantee in particular.
2628

2729
As new APIs are added to N-API, node-addon-api must be updated to provide
2830
wrappers for those new APIs. For this reason node-addon-api provides
@@ -167,3 +169,5 @@ Take a look and get inspired by our **[test suite](https://github.com/nodejs/nod
167169
<a name="license"></a>
168170

169171
Licensed under [MIT](./LICENSE.md)
172+
173+
[ABI stability guide]: https://nodejs.org/en/docs/guides/abi-stability/

0 commit comments

Comments
 (0)