node/doc/api
Gerhard Stöbich 9e892e22e3
doc: add overhead hints for heap snapshot generation
Added some hints that creation of an heap snapshot has significant
overhead on memory requirement and event loop utilization.

PR-URL: https://github.com/nodejs/node/pull/41822
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2022-02-04 19:16:41 +00:00
..
addons.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
assert.md doc: remove SameValue comparison reference 2022-01-13 06:17:05 +00:00
async_context.md doc: edit async_context context loss text 2022-01-18 18:13:34 +00:00
async_hooks.md async_hooks: fix imports in context example 2022-02-03 12:30:36 +00:00
buffer.md doc: improve 'hex' Buffer decoding description and examples 2022-01-22 00:55:24 +01:00
child_process.md 2022-01-18, Version 17.4.0 (Current) 2022-01-18 16:03:23 +01:00
cli.md 2022-02-01, Version 14.19.0 'Fermium' (LTS) 2022-02-01 08:30:03 -05:00
cluster.md doc: use UDPv4/UDPv6 consistently with TCPv4/TCPv6 2022-02-02 19:48:54 +00:00
console.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
corepack.md 2022-02-01, Version 14.19.0 'Fermium' (LTS) 2022-02-01 08:30:03 -05:00
crypto.md doc: fix X509 CA acronym capitalization 2022-02-04 03:46:30 +00:00
debugger.md doc: add information on suppressing initial break in debugger 2021-11-26 08:58:39 +00:00
deprecations.md doc: deprecate buffer.slice 2022-01-22 00:34:36 +01:00
dgram.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
diagnostics_channel.md 2022-02-01, Version 14.19.0 'Fermium' (LTS) 2022-02-01 08:30:03 -05:00
dns.md doc: fix markdown syntax and HTML tag misses 2021-10-28 09:22:57 -07: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 tools,doc: use V8::DisposePlatform 2022-02-02 17:25:01 +01:00
errors.md 2022-02-01, Version 14.19.0 'Fermium' (LTS) 2022-02-01 08:30:03 -05:00
esm.md module: unflag esm json modules 2022-01-31 22:16:37 +00:00
events.md 2022-01-18, Version 17.4.0 (Current) 2022-01-18 16:03:23 +01:00
fs.md doc: expand fs.access() mode parameter docs 2022-01-14 11:46:57 -05:00
globals.md lib: add fetch 2022-02-01 08:17:50 +00:00
http2.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
http.md doc: use example.com for examples 2022-02-03 06:39:01 +00:00
https.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
index.md tools: avoid unnecessary escaping in markdown formatter 2021-10-31 09:36:05 -07:00
inspector.md doc: update output in inspector examples 2022-01-10 10:15:23 +00: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: update modules.md wording 2022-01-30 14:26:14 +00:00
n-api.md doc: clarify parameter for napi_get_cb_info 2022-01-25 11:39:23 -05:00
net.md doc: expand entries for isIP(), isIPv4(), and isIPv6() 2021-12-02 21:22:48 +00:00
os.md doc: improve docs to give descriptive info for the platform property 2022-01-28 00:12:01 +00:00
packages.md 2022-02-01, Version 14.19.0 'Fermium' (LTS) 2022-02-01 08:30:03 -05:00
path.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
perf_hooks.md 2022-01-18, Version 17.4.0 (Current) 2022-01-18 16:03:23 +01:00
policy.md doc: add blank line between comments 2021-09-21 18:40:04 -07:00
process.md doc: improve docs to give descriptive info for the platform property 2022-01-28 00:12:01 +00: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: simplify readline/stdin text 2022-01-23 03:21:17 +00: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 stream: add reduce 2022-01-30 14:07:32 +00:00
string_decoder.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
synopsis.md doc: clarify module system selection 2022-01-17 11:36:19 +01:00
timers.md 2021-12-17, Version 17.3.0 (Current) 2021-12-17 18:13:50 -05:00
tls.md doc: use sentence case for X509 error codes header 2022-02-03 20:20:52 +00:00
tracing.md doc: add note for handling signal events in trace events 2022-01-21 23:53:43 +00:00
tty.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
url.md doc: clarify treatment of non-string base in URL() 2022-01-27 05:45:53 +00:00
util.md doc: use Object.hasOwn() in util doc 2022-01-31 09:16:18 +00:00
v8.md doc: add overhead hints for heap snapshot generation 2022-02-04 19:16:41 +00: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 crypto: adjust types for getRandomValues 2022-01-22 15:20:40 +01:00
webstreams.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
worker_threads.md doc: fix example description for worker_threads 2021-12-31 00:16:14 +00:00
zlib.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00