Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTobias Nießen <tniessen@tnie.de>2022-01-23 03:15:51 +0300
committerGitHub <noreply@github.com>2022-01-23 03:15:51 +0300
commit312b0fc7530f9543b0d3c448b56639115f61adf7 (patch)
tree0066fcd8e6de3608da6658aab1f49e0371e6c0a7 /doc/api/cluster.md
parentd01c645b9b31c647c0afe57e9c2b78028e26f44f (diff)
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>
Diffstat (limited to 'doc/api/cluster.md')
-rw-r--r--doc/api/cluster.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/api/cluster.md b/doc/api/cluster.md
index d34b1bb795c..5dfd8116dc5 100644
--- a/doc/api/cluster.md
+++ b/doc/api/cluster.md
@@ -6,9 +6,10 @@
<!-- source_link=lib/cluster.js -->
-A single instance of Node.js runs in a single thread. To take advantage of
-multi-core systems, the user will sometimes want to launch a cluster of Node.js
-processes to handle the load.
+Clusters of Node.js processes can be used to run multiple instances of Node.js
+that can distribute workloads among their application threads. When process
+isolation is not needed, use the [`worker_threads`][] module instead, which
+allows running multiple application threads within a single Node.js instance.
The cluster module allows easy creation of child processes that all share
server ports.
@@ -1121,3 +1122,4 @@ socket.on('data', (id) => {
[`process` event: `'message'`]: process.md#event-message
[`server.close()`]: net.md#event-close
[`worker.exitedAfterDisconnect`]: #workerexitedafterdisconnect
+[`worker_threads`]: worker_threads.md