Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: clarify use of NAPI_EXPERIMENTAL #35195

Closed
wants to merge 9 commits into from
Closed

doc: clarify use of NAPI_EXPERIMENTAL #35195

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
74c6564
doc: clarify use of NAPI_EXPERIMENTAL
mhdawson Sep 14, 2020
e1e0178
Update doc/api/n-api.md
mhdawson Sep 17, 2020
36d8e94
Update doc/api/n-api.md
mhdawson Sep 17, 2020
9a976c2
Update doc/api/n-api.md
mhdawson Sep 17, 2020
5c5e4f6
Update doc/api/n-api.md
mhdawson Sep 17, 2020
34510f4
Update doc/api/n-api.md
mhdawson Sep 17, 2020
d8d8c90
Update doc/api/n-api.md
mhdawson Sep 18, 2020
4ed6bcc
Update doc/api/n-api.md
mhdawson Sep 18, 2020
0162f80
fix linter issues
mhdawson Sep 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,18 @@ listed as supporting a later version.
version 1 but continued to evolve until Node.js 8.6.0. The API is different in
versions prior to Node.js 8.6.0. We recommend N-API version 3 or later.

Each API documented for N-API will have a header named `added in:`, and APIs
which are stable will have the additional header `N-API version:`.
APIs are directly usable when using a Node.js version which supports
the N-API version shown in `N-API version:` or higher.
When using a Node.js version that does not support the
`N-API version:` listed or if there is no `N-API version:` listed,
then the API will only be available if
`#define NAPI_EXPERIMENTAL` precedes the inclusion of `node_api.h`
or `js_native_api.h`. If an API appears not to be available on
a version of Node.js which is later than the one shown in `added in:` then
this is most likely the reason for the apparent absence.

The N-APIs associated strictly with accessing ECMAScript features from native
code can be found separately in `js_native_api.h` and `js_native_api_types.h`.
The APIs defined in these headers are included in `node_api.h` and
Expand Down