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 N-API version 1 #34344

Closed
wants to merge 9 commits into from
Closed

doc: clarify N-API version 1 #34344

Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
71c7a51
doc: clarify N-API version 1
mhdawson Jul 13, 2020
6904325
squash: fixup formatting of note
mhdawson Jul 13, 2020
9455cdc
Update doc/api/n-api.md
mhdawson Jul 16, 2020
4bc4c13
Update doc/api/n-api.md
mhdawson Jul 16, 2020
6713a61
Update doc/api/n-api.md
mhdawson Jul 16, 2020
7d81104
Update doc/api/n-api.md
mhdawson Jul 20, 2020
c9ad6f1
Update doc/api/n-api.md
mhdawson Jul 21, 2020
127f153
Update doc/api/n-api.md
mhdawson Jul 22, 2020
2ece38b
Update doc/api/n-api.md
mhdawson Jul 29, 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
26 changes: 16 additions & 10 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,19 +240,25 @@ from version 3 with some additions. This means that it is not necessary
to recompile for new versions of Node.js which are
listed as supporting a later version.

| | 1 | 2 | 3 | 4 | 5 | 6 |
|-------|---------|----------|----------|----------|-----------|-----------|
| v6.x | | | v6.14.2* | | | |
| v8.x | v8.0.0* | v8.10.0* | v8.11.2 | v8.16.0 | | |
| v9.x | v9.0.0* | v9.3.0* | v9.11.0* | | | |
| v10.x | v10.0.0 | v10.0.0 | v10.0.0 | v10.16.0 | v10.17.0 | v10.20.0 |
| v11.x | v11.0.0 | v11.0.0 | v11.0.0 | v11.8.0 | | |
| v12.x | v12.0.0 | v12.0.0 | v12.0.0 | v12.0.0 | v12.11.0 | v12.17.0 |
| v13.x | v13.0.0 | v13.0.0 | v13.0.0 | v13.0.0 | v13.0.0 | |
| v14.x | v14.0.0 | v14.0.0 | v14.0.0 | v14.0.0 | v14.0.0 | v14.0.0 |
| | 1 | 2 | 3 | 4 | 5 | 6 |
|-------|----------|----------|----------|----------|-----------|-----------|
| v6.x | | | v6.14.2* | | | |
| v8.x | v8.7.0** | v8.10.0* | v8.11.2 | v8.16.0 | | |
mhdawson marked this conversation as resolved.
Show resolved Hide resolved
| v9.x | v9.0.0* | v9.3.0* | v9.11.0* | | | |
| v10.x | v10.0.0 | v10.0.0 | v10.0.0 | v10.16.0 | v10.17.0 | v10.20.0 |
| v11.x | v11.0.0 | v11.0.0 | v11.0.0 | v11.8.0 | | |
| v12.x | v12.0.0 | v12.0.0 | v12.0.0 | v12.0.0 | v12.11.0 | v12.17.0 |
| v13.x | v13.0.0 | v13.0.0 | v13.0.0 | v13.0.0 | v13.0.0 | |
| v14.x | v14.0.0 | v14.0.0 | v14.0.0 | v14.0.0 | v14.0.0 | v14.0.0 |

\* Indicates that the N-API version was released as experimental

\*\* First version which matches version 1 in later releases. While v8.0.0
included N-API as experimental, version 1 continued to evolve until
mhdawson marked this conversation as resolved.
Show resolved Hide resolved
v8.7.0 and therefore the shape of the API in earlier versions is not
mhdawson marked this conversation as resolved.
Show resolved Hide resolved
truly version 1 (in hindsight we should have called it version 0). The
mhdawson marked this conversation as resolved.
Show resolved Hide resolved
general recommendation is to use version 3 or later.
mhdawson marked this conversation as resolved.
Show resolved Hide resolved

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