0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-29 07:00:59 +01:00
nodejs/doc/api
Gabriel Schulhof af83dcd5f4 doc: document n-api callback scope usage
Document that it is not necessary to open handle and/or callback scopes
inside finalizer, async work, thread-safe function etc. callbacks
unless for reasons documented in the section about object lifetime
management.

Link usage of callback signatures to their definition.

Fixes: https://github.com/nodejs/node/issues/33893
PR-URL: https://github.com/nodejs/node/pull/33915
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2020-06-23 15:50:43 -07:00
..
addons.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
assert.md 2020-05-05, Version 14.2.0 (Current) 2020-05-05 20:24:37 +02:00
async_hooks.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
buffer.md doc: use a single space between sentences 2020-06-22 19:29:18 -07:00
child_process.md doc: use a single space between sentences 2020-06-22 19:29:18 -07:00
cli.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
cluster.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
console.md 2020-05-26, Version 12.17.0 'Erbium' (LTS) 2020-05-26 15:55:39 +02:00
crypto.md doc: use a single space between sentences 2020-06-22 19:29:18 -07:00
debugger.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
deprecations.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
dgram.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
dns.md doc: revise text in dns module documentation introduction 2020-06-22 10:08:14 -07:00
documentation.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
domain.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
embedding.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
errors.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
esm.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
events.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
fs.md fs: implement lutimes 2020-06-23 09:14:28 +00:00
globals.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
http2.md doc: correct default values in http2 docs 2020-06-22 19:30:35 -07:00
http.md http: expose host and protocol on ClientRequest 2020-06-22 16:52:29 +02:00
https.md doc: standardize constructor doc header layout 2020-06-10 05:31:21 -07:00
index.md doc: change "GitHub Repo" to "Code repository" 2020-06-21 21:27:29 -07:00
inspector.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
intl.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
modules.md doc: use a single space between sentences 2020-06-22 19:29:18 -07:00
n-api.md doc: document n-api callback scope usage 2020-06-23 15:50:43 -07:00
net.md doc: use a single space between sentences 2020-06-22 19:29:18 -07:00
os.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
path.md doc: fixed a grammatical error in path.md 2020-05-23 17:13:28 +02:00
perf_hooks.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
policy.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
process.md doc: use a single space between sentences 2020-06-22 19:29:18 -07:00
punycode.md doc,punycode: use code markup/markdown in headers 2019-12-26 21:39:30 -08:00
querystring.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
quic.md doc: use a single space between sentences 2020-06-22 19:29:18 -07:00
readline.md doc: use a single space between sentences 2020-06-22 19:29:18 -07:00
repl.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
report.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
stream.md doc: use a single space between sentences 2020-06-22 19:29:18 -07:00
string_decoder.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
synopsis.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
timers.md timers: introduce timers/promises 2020-06-22 14:29:49 -07:00
tls.md doc: use a single space between sentences 2020-06-22 19:29:18 -07:00
tracing.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
tty.md doc: normalize Bash code block info strings 2020-05-25 19:08:45 +02:00
url.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
util.md doc: use a single space between sentences 2020-06-22 19:29:18 -07:00
v8.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
vm.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00
wasi.md doc: update WASM code sample 2020-06-19 09:57:28 -07:00
worker_threads.md crypto: allow KeyObjects in postMessage 2020-06-22 20:50:38 +02:00
zlib.md doc: use sentence-case for headings in docs 2020-06-19 08:09:05 -07:00