Skip to content

Commit 5ff4300

Browse files
Gabriel Schulhoftargos
Gabriel Schulhof
authored andcommitted
doc: add link to ABI guide
Provides a link from the N-API reference to the guide discussing ABI stability in greater depth. Re: nodejs/abi-stable-node#332 PR-URL: #23287 Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>
1 parent 4d761d4 commit 5ff4300

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

doc/api/n-api.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ the underlying JavaScript runtime (ex V8) and is maintained as part of
1111
Node.js itself. This API will be Application Binary Interface (ABI) stable
1212
across versions of Node.js. It is intended to insulate Addons from
1313
changes in the underlying JavaScript engine and allow modules
14-
compiled for one version to run on later versions of Node.js without
15-
recompilation.
14+
compiled for one major version to run on later major versions of Node.js without
15+
recompilation. The [ABI Stability][] guide provides a more in-depth explanation.
1616

1717
Addons are built/packaged with the same approach/tools
1818
outlined in the section titled [C++ Addons](addons.html).
@@ -4596,6 +4596,7 @@ idempotent.
45964596

45974597
This API may only be called from the main thread.
45984598

4599+
[ABI Stability]: https://nodejs.org/en/docs/guides/abi-stability/
45994600
[ECMAScript Language Specification]: https://tc39.github.io/ecma262/
46004601
[Error Handling]: #n_api_error_handling
46014602
[Native Abstractions for Node.js]: https://github.com/nodejs/nan

0 commit comments

Comments
 (0)