Skip to content

Commit 23f77b7

Browse files
Karnav123Ceres6
authored andcommitted
doc: improve the documentation of the stdio option
Fixes: nodejs#47705 PR-URL: nodejs#48110 Refs: https://nodejs.org/docs/latest-v20.x/api/cluster.html#clustersettings Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 37dda22 commit 23f77b7

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/api/cluster.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -935,7 +935,8 @@ changes:
935935
**Default:** `false`.
936936
* `stdio` {Array} Configures the stdio of forked processes. Because the
937937
cluster module relies on IPC to function, this configuration must contain an
938-
`'ipc'` entry. When this option is provided, it overrides `silent`.
938+
`'ipc'` entry. When this option is provided, it overrides `silent`. See
939+
[`child_process.spawn()`][]'s [`stdio`][].
939940
* `uid` {number} Sets the user identity of the process. (See setuid(2).)
940941
* `gid` {number} Sets the group identity of the process. (See setgid(2).)
941942
* `inspectPort` {number|Function} Sets inspector port of worker.
@@ -1092,6 +1093,7 @@ for (const worker of Object.values(cluster.workers)) {
10921093
[`.setupPrimary()`]: #clustersetupprimarysettings
10931094
[`ChildProcess.send()`]: child_process.md#subprocesssendmessage-sendhandle-options-callback
10941095
[`child_process.fork()`]: child_process.md#child_processforkmodulepath-args-options
1096+
[`child_process.spawn()`]: child_process.md#child_processspawncommand-args-options
10951097
[`child_process` event: `'exit'`]: child_process.md#event-exit
10961098
[`child_process` event: `'message'`]: child_process.md#event-message
10971099
[`cluster.isPrimary`]: #clusterisprimary
@@ -1100,5 +1102,6 @@ for (const worker of Object.values(cluster.workers)) {
11001102
[`kill()`]: process.md#processkillpid-signal
11011103
[`process` event: `'message'`]: process.md#event-message
11021104
[`server.close()`]: net.md#event-close
1105+
[`stdio`]: child_process.md#optionsstdio
11031106
[`worker.exitedAfterDisconnect`]: #workerexitedafterdisconnect
11041107
[`worker_threads`]: worker_threads.md

0 commit comments

Comments
 (0)