diff options
| author | Michael Dawson <michael_dawson@ca.ibm.com> | 2020-07-13 23:44:06 +0300 |
|---|---|---|
| committer | Michael Dawson <michael_dawson@ca.ibm.com> | 2020-07-30 01:24:49 +0300 |
| commit | 15333ad552b3e81cc325f31c9920ea7bbb07be0c (patch) | |
| tree | f8762ccddb09266450d8cee863ee9736f5d9474f /doc/api/n-api.md | |
| parent | 168b22ba073ee1cbf8d0bcb4ded7ff3099335d04 (diff) | |
doc: clarify N-API version 1
Refs: https://github.com/nodejs/node-addon-api/issues/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 <michael_dawson@ca.ibm.com>
PR-URL: https://github.com/nodejs/node/pull/34344
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com>
Diffstat (limited to 'doc/api/n-api.md')
| -rw-r--r-- | doc/api/n-api.md | 26 |
1 files changed, 16 insertions, 10 deletions
diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 1968e71b566..f45dd2dd4c6 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -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.6.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 | \* 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 +v8.6.0 and therefore the shape of the API in earlier versions is not +truly version 1 (in hindsight we should have called it version 0). +We recommend version 3 or later. + 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 |