diff options
| author | Rich Trott <rtrott@gmail.com> | 2020-07-30 20:33:33 +0300 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2020-08-02 03:04:41 +0300 |
| commit | aeaf16194bac6510a48019b4b55481006f11f714 (patch) | |
| tree | 1ef5dbd81134433154585c00de3c0585492dd7ff /doc/api/n-api.md | |
| parent | 45fa216ee533abc189d4b9bf0fc8f40430af7ef4 (diff) | |
doc: revise N-API versions matrix text
Revise text for clarity, brevity, and conformance with our style guide.
PR-URL: https://github.com/nodejs/node/pull/34566
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/n-api.md')
| -rw-r--r-- | doc/api/n-api.md | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 8dff1e0e15f..6b847193623 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -251,13 +251,11 @@ listed as supporting a later version. | 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 +\* N-API was 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. +\*\* Node.js 8.0.0 included N-API as experimental. It was released as N-API +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. 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`. |