Skip to content

Commit e2bea73

Browse files
mhdawsoncodebytere
authored andcommitted
doc: clarify N-API version 1
Refs: nodejs/node-addon-api#760 Clarify which version of 8.x in which N-API version 1 matches the shape in later versions like 10.x Signed-off-by: Michael Dawson <[email protected]> PR-URL: #34344 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Gabriel Schulhof <[email protected]>
1 parent 335cb0d commit e2bea73

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

doc/api/n-api.md

+16-10
Original file line numberDiff line numberDiff line change
@@ -240,19 +240,25 @@ from version 3 with some additions. This means that it is not necessary
240240
to recompile for new versions of Node.js which are
241241
listed as supporting a later version.
242242

243-
| | 1 | 2 | 3 | 4 | 5 | 6 |
244-
|-------|---------|----------|----------|----------|-----------|-----------|
245-
| v6.x | | | v6.14.2* | | | |
246-
| v8.x | v8.0.0* | v8.10.0* | v8.11.2 | v8.16.0 | | |
247-
| v9.x | v9.0.0* | v9.3.0* | v9.11.0* | | | |
248-
| v10.x | v10.0.0 | v10.0.0 | v10.0.0 | v10.16.0 | v10.17.0 | v10.20.0 |
249-
| v11.x | v11.0.0 | v11.0.0 | v11.0.0 | v11.8.0 | | |
250-
| v12.x | v12.0.0 | v12.0.0 | v12.0.0 | v12.0.0 | v12.11.0 | |
251-
| v13.x | v13.0.0 | v13.0.0 | v13.0.0 | v13.0.0 | v13.0.0 | |
252-
| v14.x | v14.0.0 | v14.0.0 | v14.0.0 | v14.0.0 | v14.0.0 | v14.0.0 |
243+
| | 1 | 2 | 3 | 4 | 5 | 6 |
244+
|-------|----------|----------|----------|----------|-----------|-----------|
245+
| v6.x | | | v6.14.2* | | | |
246+
| v8.x | v8.6.0** | v8.10.0* | v8.11.2 | v8.16.0 | | |
247+
| v9.x | v9.0.0* | v9.3.0* | v9.11.0* | | | |
248+
| v10.x | v10.0.0 | v10.0.0 | v10.0.0 | v10.16.0 | v10.17.0 | v10.20.0 |
249+
| v11.x | v11.0.0 | v11.0.0 | v11.0.0 | v11.8.0 | | |
250+
| v12.x | v12.0.0 | v12.0.0 | v12.0.0 | v12.0.0 | v12.11.0 | v12.17.0 |
251+
| v13.x | v13.0.0 | v13.0.0 | v13.0.0 | v13.0.0 | v13.0.0 | |
252+
| v14.x | v14.0.0 | v14.0.0 | v14.0.0 | v14.0.0 | v14.0.0 | v14.0.0 |
253253

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

256+
\*\* First version which matches version 1 in later releases. While v8.0.0
257+
included N-API as experimental, version 1 continued to evolve until
258+
v8.6.0 and therefore the shape of the API in earlier versions is not
259+
truly version 1 (in hindsight we should have called it version 0).
260+
We recommend version 3 or later.
261+
256262
The N-APIs associated strictly with accessing ECMAScript features from native
257263
code can be found separately in `js_native_api.h` and `js_native_api_types.h`.
258264
The APIs defined in these headers are included in `node_api.h` and

0 commit comments

Comments
 (0)