Skip to content

Commit

Permalink
doc: add link to ABI guide
Browse files Browse the repository at this point in the history
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 <thechargingvolcano@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
  • Loading branch information
Gabriel Schulhof authored and targos committed Oct 10, 2018
1 parent 4d761d4 commit 5ff4300
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/api/n-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ the underlying JavaScript runtime (ex V8) and is maintained as part of
Node.js itself. This API will be Application Binary Interface (ABI) stable
across versions of Node.js. It is intended to insulate Addons from
changes in the underlying JavaScript engine and allow modules
compiled for one version to run on later versions of Node.js without
recompilation.
compiled for one major version to run on later major versions of Node.js without
recompilation. The [ABI Stability][] guide provides a more in-depth explanation.

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

This API may only be called from the main thread.

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

0 comments on commit 5ff4300

Please sign in to comment.