node/doc/api
Tobias Nießen 312b0fc753
doc: suggest worker threads in cluster docs
The current documentation is incorrect in that it says "A single
instance of Node.js runs in a single thread," which is not true due
to the addition of worker threads.

This patch removes the incorrect statement and instead suggests that
applications consider using worker threads when process isolation is
not needed.

Refs: https://github.com/nodejs/node/pull/20876

PR-URL: https://github.com/nodejs/node/pull/41616
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
2022-01-23 00:15:51 +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 doc: fix async_hooks example in api docs 2022-01-21 02:37:21 +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 doc: clarify module system selection 2022-01-17 11:36:19 +01:00
cluster.md doc: suggest worker threads in cluster docs 2022-01-23 00:15:51 +00:00
console.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
corepack.md doc: fix corepack grammar for --force flag 2021-11-09 18:12:48 +01:00
crypto.md crypto: change default check(Host|Email) behavior 2022-01-22 18:36:47 +01: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 2021-11-09, Version 17.1.0 (Current) 2021-11-09 20:06:12 +01: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 doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
errors.md crypto,tls: implement safe x509 GeneralName format 2022-01-10 22:38:05 +00:00
esm.md doc: fix typos in esm.md 2022-01-17 16:54:10 +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 worker: expose BroadcastChannel as a global 2021-12-24 08:32:48 -08:00
http2.md doc: format doc/api/*.md with markdown formatter 2021-10-20 11:59:11 +02:00
http.md doc: revise HTTPRequestOptions text 2022-01-08 05:31:40 +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: recommend package exports instead of requiring folders 2022-01-18 18:13:44 +00:00
n-api.md doc: fix example in node-api docs 2021-12-23 13:31:54 -05:00
net.md doc: expand entries for isIP(), isIPv4(), and isIPv6() 2021-12-02 21:22:48 +00:00
os.md doc: fix markdown syntax and HTML tag misses 2021-10-28 09:22:57 -07:00
packages.md doc: clarify module system selection 2022-01-17 11:36:19 +01: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: fix cjs example code for process.arch 2022-01-19 16:57:13 +01: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 readline: add feature yank and yank pop 2022-01-22 05:42:48 +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: support some and every 2022-01-21 12:10:17 +02: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: do not reference SSL when discussing SNI 2022-01-18 13:44:38 +01: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,lib,tools: align multiline comments 2021-12-09 08:31:35 -08:00
util.md doc: simplify util.TextDecoder example 2022-01-20 05:12:39 +00:00
v8.md v8: make writeHeapSnapshot throw if fopen fails 2022-01-12 08:39:49 +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