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: https://github.com/nodejs/node/pull/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>
This commit is contained in:
parent
b9ff6a3fb1
commit
18405e66d2
@ -8,7 +8,13 @@ can be loaded into Node.js using the [`require()`][require] function, and used
|
||||
just as if they were an ordinary Node.js module. They are used primarily to
|
||||
provide an interface between JavaScript running in Node.js and C/C++ libraries.
|
||||
|
||||
At the moment, the method for implementing Addons is rather complicated,
|
||||
There are three options for implementing Addons: N-API, nan, or direct
|
||||
use of internal V8, libuv and Node.js libraries. Unless you need direct
|
||||
access to functionality which is not exposed by N-API, use N-API.
|
||||
Refer to the section [C/C++ Addons - N-API](n-api.html)
|
||||
for more information on N-API.
|
||||
|
||||
When not using N-API, implementing Addons is complicated,
|
||||
involving knowledge of several components and APIs:
|
||||
|
||||
- V8: the C++ library Node.js currently uses to provide the
|
||||
|
Loading…
x
Reference in New Issue
Block a user