node/doc/api
Elliot Goodrich dda30f972a
doc: fix module customization hook examples
When running these examples, `node` fails to return as this
`MessagePort` keeps the event loop active in the main thread unless
it is `unref()`ed.

Fixes: https://github.com/nodejs/node/issues/52846
PR-URL: https://github.com/nodejs/node/pull/53637
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
2024-07-01 13:34:35 +00:00
..
addons.md src: use args.This() instead of Holder 2024-06-18 16:02:42 +00:00
assert.md assert,util: change WeakMap and WeakSet comparison handling 2024-06-28 07:28:55 +00:00
async_context.md 2023-04-18, Version 20.0.0 (Current) 2023-04-18 13:04:39 -03:00
async_hooks.md doc: declare path on example of async_hooks.executionAsyncId() 2023-07-18 20:00:50 +00:00
buffer.md doc: add Buffer.from(string) to functions that use buffer pool 2024-06-14 12:27:01 +00:00
child_process.md doc: add example for execFileSync method and ref to stdio 2024-05-12 07:18:40 +00:00
cli.md 2024-06-20, Version 20.15.0 'Iron' (LTS) 2024-06-20 17:55:41 +02:00
cluster.md doc: improve the documentation of the stdio option 2023-05-30 06:10:58 +00:00
console.md doc: update to align console.table row to the left 2023-11-06 16:47:53 +00:00
corepack.md doc: update pnpm link 2024-03-18 14:27:59 +00:00
crypto.md doc: doc-only deprecate OpenSSL engine-based APIs 2024-06-07 16:10:47 +00:00
debugger.md inspector: introduce the --inspect-wait flag 2024-05-11 18:48:30 +00:00
deprecations.md Revert "util: move util._extend to eol" 2024-06-14 13:07:58 +00:00
dgram.md doc: use consistent plural form of "index" 2024-04-07 06:46:29 +00:00
diagnostics_channel.md lib: add diagnostics_channel events to module loading 2024-06-20 21:25:04 -03:00
dns.md doc: fix dns.lookup family 0 and all descriptions 2024-05-11 20:37:30 +02:00
documentation.md doc: use consistent plural form of "index" 2024-04-07 06:46:29 +00:00
domain.md doc: fix typos 2023-04-23 13:34:08 +00:00
embedding.md test,doc: enable running embedtest for Windows 2024-05-23 18:33:40 +00:00
errors.md stream: pipe to a closed or destroyed stream is not allowed in pipeline 2024-06-14 08:27:56 +00:00
esm.md doc: remove cases for keys not containing "*" in PATTERN_KEY_COMPARE 2024-06-05 11:20:26 +00:00
events.md doc, typings: events.once accepts symbol event type 2024-06-27 21:56:25 +00:00
fs.md doc: clarify that fs.exists() may return false for existing symlink 2024-06-26 09:38:30 +00:00
globals.md deps,lib,src: add experimental web storage 2024-06-14 18:40:04 +00:00
http2.md tools: use stylistic ESLint plugin for formatting 2024-04-15 15:08:10 +00:00
http.md doc: note http.closeAllConnections excludes upgraded sockets 2024-06-25 10:32:47 +00:00
https.md doc: doc-only deprecate OpenSSL engine-based APIs 2024-06-07 16:10:47 +00:00
index.md src: add initial support for single executable applications 2023-02-18 02:49:18 +00:00
inspector.md doc: updates for better json generating 2024-02-13 21:37:42 +00:00
intl.md doc: improve documentation about ICU data fallback 2023-09-22 13:24:23 +00:00
module.md doc: fix module customization hook examples 2024-07-01 13:34:35 +00:00
modules.md doc: improve explanation about built-in modules 2024-05-28 20:23:14 +00:00
n-api.md doc: recommend not using libuv node-api function 2024-06-24 15:29:21 -04:00
net.md src: add UV_PIPE_NO_TRUNCATE for bind in pipe_wrap.cc 2024-05-06 12:56:36 +00:00
os.md doc: add esm example for os 2024-06-29 13:57:49 +00:00
packages.md lib,doc: replace references to import assertions 2024-05-17 08:07:48 +00:00
path.md path: add matchGlob method 2024-06-23 06:08:59 +00:00
perf_hooks.md 2024-05-15, Version 22.2.0 (Current) 2024-05-15 21:21:22 +02:00
permissions.md src,permission: --allow-wasi & prevent WASI exec 2024-06-01 13:13:12 +00:00
process.md timers: emit warning if delay is negative or NaN 2024-06-28 11:36:31 +00:00
punycode.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
querystring.md doc: get rid of unnecessary eslint-skip comments 2023-11-22 19:03:33 +00:00
readline.md doc: detailed description of keystrokes Ctrl-Y and Meta-Y 2023-08-08 19:51:43 +00:00
repl.md doc: harmonize fenced code snippet flags 2023-05-21 09:36:57 +02:00
report.md 2024-05-07, Version 20.13.0 'Iron' (LTS) 2024-05-07 17:32:24 +02:00
single-executable-applications.md 2024-03-26, Version 20.12.0 'Iron' (LTS) 2024-03-26 17:42:38 +00:00
stream.md stream: update outdated highwatermark doc 2024-06-20 08:59:14 +00:00
string_decoder.md doc: add print results for examples in StringDecoder 2023-08-27 15:32:47 +00:00
synopsis.md doc: clarify explaination text on how to run the example 2023-10-06 13:37:31 +00:00
test.md doc: fix doc for correct usage with plan & TestContext 2024-06-29 19:20:35 +00:00
timers.md timers: emit warning if delay is negative or NaN 2024-06-28 11:36:31 +00:00
tls.md doc: doc-only deprecate OpenSSL engine-based APIs 2024-06-07 16:10:47 +00:00
tracing.md src: trace threadpool event 2022-11-01 04:21:13 +00:00
tty.md doc: clarify tty.isRaw 2023-05-21 16:41:28 +00:00
url.md 2024-05-07, Version 20.13.0 'Iron' (LTS) 2024-05-07 17:32:24 +02:00
util.md util: support --no- for argument with boolean type for parseArgs 2024-06-19 15:36:18 +00:00
v8.md 2024-05-07, Version 20.13.0 'Iron' (LTS) 2024-05-07 17:32:24 +02:00
vm.md 2024-03-26, Version 20.12.0 'Iron' (LTS) 2024-03-26 17:42:38 +00:00
wasi.md 2024-01-09, Version 20.11.0 'Iron' (LTS) 2024-01-09 20:47:16 +00:00
webcrypto.md crypto: make deriveBits length parameter optional and nullable 2024-06-28 22:21:29 +00:00
webstreams.md doc: fix grammatical mistake 2024-05-03 13:30:09 +00:00
worker_threads.md doc: updates for better json generating 2024-02-13 21:37:42 +00:00
zlib.md 2024-06-20, Version 20.15.0 'Iron' (LTS) 2024-06-20 17:55:41 +02:00