Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
73 commits
Select commit Hold shift + click to select a range
fb89be6
doc: use correct Error type for EventEmitter.defaultMaxListener
Trott Sep 5, 2020
25f93f3
test: add more valid results to test-trace-atomics-wait
addaleax Sep 5, 2020
f3c45a1
Revert "build: require "allow edits" to be checked"
Trott Sep 7, 2020
9faaa65
test: separate the test fixtures between ICU and URL
Leko Sep 6, 2020
1cf9934
doc: make minor improvements to module.md
Trott Sep 6, 2020
bc38485
test: fix comment about DNS lookup test
tniessen Sep 6, 2020
3573545
crypto: improve randomInt out-of-range error message
Trott Sep 7, 2020
1bb0ed3
crypto: improve invalid arg type message for randomInt()
Trott Sep 7, 2020
6627c1f
test: remove setMaxListeners in test-crypto-random
tniessen Sep 6, 2020
0a2610a
doc: avoid double-while sentence in perf_hooks.md
Trott Sep 6, 2020
93e4d54
doc: add note about path.basename on Windows
tniessen Sep 5, 2020
379c5ce
test: revise test-policy-integrity
Trott Sep 8, 2020
314483c
module: fix specifier resolution option value
himself65 Sep 8, 2020
79c6d92
doc: fix broken links in deprecations.md
Trott Sep 8, 2020
f4e958f
doc: fix broken link in fs.md
Trott Sep 8, 2020
5c8d208
doc: fix broken link in http2.md
Trott Sep 9, 2020
aa93c1c
doc: fix broken link in perf_hooks.md
Trott Sep 9, 2020
b75822d
doc,test: specify and test CLI option precedence rules
addaleax Sep 8, 2020
6e622d6
esm: better package.json parser errors
guybedford Sep 9, 2020
122edad
doc: update security process
mhdawson Sep 8, 2020
d4389b5
deps: update to uvwasi 0.0.11
cjihrig Sep 8, 2020
46b9f4b
doc: add missing changes entry for breakEvalOnSigint REPL option
addaleax Sep 10, 2020
f4e714a
doc: update my email address
mhdawson Sep 8, 2020
4bde865
errors: simplify ERR_REQUIRE_ESM message generation
Trott Sep 9, 2020
df70861
doc: simplify circular dependencies text in modules.md
Trott Sep 9, 2020
977b0ed
http: allow Content-Length header for 304 responses
BlackYoup Aug 18, 2020
f21a5c6
meta: update my collab entry
devsnek Sep 12, 2020
5229ffa
buffer: adjust validation to account for buffer.kMaxLength
addaleax Sep 9, 2020
8ea2853
http: only set keep-alive when not exists
atian25 Sep 8, 2020
331142c
doc: update contact info for Ash Cripps
Sep 10, 2020
7dbcd24
doc: fix left nav color contrast
Trott Sep 10, 2020
e410514
doc: improve table accessibility
Trott Sep 10, 2020
ae85228
doc: perform minor cleanup on cli.md
Trott Sep 11, 2020
12f2934
meta: add links to OpenJSF Slack
mmarchini Sep 9, 2020
99785e4
doc: fix minor punctuation issue in path.md
amilajack Sep 9, 2020
f2cc1c2
build: filter issues & PRs to auto close by matching on stalled label
phillipj Sep 11, 2020
e8d479e
doc: perform cleanup on security-release-process.md
Trott Sep 11, 2020
dc4c569
doc: add missing copyFile change history
codebytere Sep 4, 2020
176e9e4
doc: fix broken links in modules.md
Trott Sep 14, 2020
32d1731
doc: update process.release
schamberg97 Sep 12, 2020
aea3f77
doc: update eventLoopUtilization documentation
addaleax Sep 11, 2020
0a97f44
tools: update ESLint to 7.9.0
cjihrig Sep 12, 2020
066148d
doc: remove problematic auto-linking of curl man pages
Trott Sep 13, 2020
49da459
test: improve pummel/test-timers.js
Trott Sep 13, 2020
76e24f9
module: use isURLInstance instead of instanceof
aduh95 Aug 27, 2020
beb75bd
fs: loosen validation to allow objects with an own toString function
ljharb Aug 31, 2020
910deff
doc: fix broken link in crypto.md
Trott Sep 14, 2020
c1e16d1
doc: fix deprecation documentation inconsistencies
aduh95 Sep 6, 2020
e5fffe2
doc: fix missing word in dgram.md
Nibbler999 Sep 16, 2020
70ec369
doc: replace "you should do X" with "do X"
Trott Sep 14, 2020
c1c93a6
doc: use command-line/command line consistently
Trott Sep 15, 2020
dbfd3b2
doc: remove "end user"
Trott Sep 15, 2020
92a14d3
doc: add technical values document
mhdawson Sep 10, 2020
3d78686
build: increase API requests for stale action
phillipj Sep 16, 2020
8357b56
test: add wasi readdir() test
cjihrig Sep 1, 2020
64ac5c6
doc: fix small grammatical issues in timers.md
wjabbour Sep 15, 2020
7f3b2b2
n-api: add more property defaults
Flarna Sep 15, 2020
2308be0
doc: fix header level for error code
Trott Sep 15, 2020
7610fe5
doc: add issue labels sections to release guide
targos Sep 16, 2020
6d4ab36
doc: update attributes used by n-api samples (#35220)
Flarna Sep 18, 2020
6119e95
doc: clarify use of NAPI_EXPERIMENTAL
mhdawson Sep 14, 2020
ca11816
n-api: create N-API version 7
Sep 15, 2020
d195d20
doc: relax prohibition on personal pronouns
Trott Jul 14, 2020
b9161f4
doc: sort repl references in ASCII order
Trott Sep 16, 2020
b62d9b4
doc: remove excessive formatting in dgram.md
Trott Sep 16, 2020
2bc335d
doc: clarify napi_property_attributes text
Trott Sep 18, 2020
e29e2da
test: improve assertions in pummel/test-timers
Trott Sep 15, 2020
d82dd0c
doc: revise stability section of values doc
Trott Sep 17, 2020
b860a7f
doc: standardize on _backward_
Trott Sep 17, 2020
4f4faa8
readline: fix key name for function keys with modifiers
elie-g Sep 19, 2020
d8b5714
https: set requestTimeout default to 0
ronag Sep 18, 2020
836680a
doc: use present tense in error messages
Trott Sep 12, 2020
efd5c83
2020-09-22, Version 14.12.0 (Current)
ruyadorno Sep 21, 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
Prev Previous commit
Next Next commit
doc: clarify use of NAPI_EXPERIMENTAL
We've had a few questions about APIs not being available which
were related to not having specified `NAPI_EXPERIMENTAL`.

Add some additional documentation to explain this common
issue:

Refs: nodejs/node-addon-api#810

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #35195
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
  • Loading branch information
mhdawson authored and ruyadorno committed Sep 21, 2020
commit 6119e9511c2eee5a3aae6645d8896cbb80cd5740
12 changes: 12 additions & 0 deletions doc/api/n-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,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