Commit edbe38d
doc: mention N-API as recommended approach
We've had a few comments that from the doc it might not
be clear that N-API is the recommended approach for Addons.
As a start, mention N-API early in the non N-API section
as the recommended approach unless lower level access
is required.
PR-URL: #28922
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent aff1ef9 commit edbe38d
1 file changed
Lines changed: 7 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -8,7 +8,13 @@ can be loaded into Node.js using the [`require()`][require] function, and used | |||
| 8 | 8 | just as if they were an ordinary Node.js module. They are used primarily to | |
| 9 | 9 | provide an interface between JavaScript running in Node.js and C/C++ libraries. | |
| 10 | 10 | ||
| 11 | - At the moment, the method for implementing Addons is rather complicated, | ||
| 11 | + There are three options for implementing Addons: N-API, nan, or direct | ||
| 12 | + use of internal V8, libuv and Node.js libraries. Unless you need direct | ||
| 13 | + access to functionality which is not exposed by N-API, use N-API. | ||
| 14 | + Refer to the section [C/C++ Addons - N-API](n-api.html) | ||
| 15 | + for more information on N-API. | ||
| 16 | + | ||
| 17 | + When not using N-API, implementing Addons is complicated, | ||
| 12 | 18 | involving knowledge of several components and APIs: | |
| 13 | 19 | ||
| 14 | 20 | - V8: the C++ library Node.js currently uses to provide the | |
0 commit comments