Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGabriel Schulhof <gabriel.schulhof@intel.com>2018-08-24 20:11:50 +0300
committerGabriel Schulhof <gabriel.schulhof@intel.com>2018-09-03 18:32:29 +0300
commit7033fc771a1832d678cbcd7ec48b848f7acc647c (patch)
tree15f784c025133aaf6d78e64b524b2ef4488ba865 /doc/api/addons.md
parent4f70ecc9edad9c1ce1d46af8a0965cf8aca0bd28 (diff)
doc: add blurb about implications of ABI stability
Mention that ABI stability can be achieved only by linking to ABI- stable parts of Node.js and to other libraries which are ABI-stable. PR-URL: https://github.com/nodejs/node/pull/22508 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Diffstat (limited to 'doc/api/addons.md')
-rw-r--r--doc/api/addons.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/addons.md b/doc/api/addons.md
index 9ea0a6b6446..bba4820ca9c 100644
--- a/doc/api/addons.md
+++ b/doc/api/addons.md
@@ -367,6 +367,10 @@ set of APIs that are used by the native code. Instead of using the V8
or [Native Abstractions for Node.js][] APIs, the functions available
in the N-API are used.
+Creating and maintaining an addon that benefits from the ABI stability
+provided by N-API carries with it certain
+[implementation considerations](n-api.html#n_api_implications_of_abi_stability).
+
To use N-API in the above "Hello world" example, replace the content of
`hello.cc` with the following. All other instructions remain the same.