node/doc/api
Michael Dawson f27f8d256e doc: clarify behavior of napi_extended_error_info
Fix up example and make it more explicit on how
you need to use napi_extended_error_info in order to
help people avoid what might be a common mistake that
we made in node-addon-api.

Refs: https://github.com/nodejs/node-addon-api/issues/1089

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

PR-URL: https://github.com/nodejs/node/pull/40458
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-10-20 16:01:50 -04:00
..
addons.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
assert.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
async_context.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
async_hooks.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
buffer.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
child_process.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
cli.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
cluster.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
console.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
corepack.md doc: add blank line between comments 2021-09-21 18:40:04 -07:00
crypto.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
debugger.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
deprecations.md 2021-10-20, Version 16.12.0 (Current) 2021-10-20 10:40:02 -04:00
dgram.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
diagnostics_channel.md lib: add unsubscribe method to non-active DC channels 2021-10-19 14:46:14 +00:00
dns.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
documentation.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
domain.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
embedding.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
errors.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
esm.md 2021-10-20, Version 16.12.0 (Current) 2021-10-20 10:40:02 -04:00
events.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
fs.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
globals.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
http2.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
http.md 2021-10-20, Version 16.12.0 (Current) 2021-10-20 10:40:02 -04:00
https.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
index.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
inspector.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
intl.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
module.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
modules.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
n-api.md doc: clarify behavior of napi_extended_error_info 2021-10-20 16:01:50 -04:00
net.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
os.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
packages.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
path.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
perf_hooks.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
policy.md doc: add blank line between comments 2021-09-21 18:40:04 -07:00
process.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
punycode.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
querystring.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
readline.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
repl.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
report.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
stream.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
string_decoder.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
synopsis.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
timers.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
tls.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
tracing.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
tty.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
url.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
util.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
v8.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
vm.md 2021-10-20, Version 16.12.0 (Current) 2021-10-20 10:40:02 -04:00
wasi.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
webcrypto.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
webstreams.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
worker_threads.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
zlib.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00