Skip to content

Commit

Permalink
doc: improve the documentation of the stdio option
Browse files Browse the repository at this point in the history
Fixes: #47705
PR-URL: #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>
  • Loading branch information
Karnav123 authored and MoLow committed Jul 6, 2023
1 parent a2aa52b commit f2bb191
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion doc/api/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -935,7 +935,8 @@ changes:
**Default:** `false`.
* `stdio` {Array} Configures the stdio of forked processes. Because the
cluster module relies on IPC to function, this configuration must contain an
`'ipc'` entry. When this option is provided, it overrides `silent`.
`'ipc'` entry. When this option is provided, it overrides `silent`. See
[`child_process.spawn()`][]'s [`stdio`][].
* `uid` {number} Sets the user identity of the process. (See setuid(2).)
* `gid` {number} Sets the group identity of the process. (See setgid(2).)
* `inspectPort` {number|Function} Sets inspector port of worker.
Expand Down Expand Up @@ -1092,6 +1093,7 @@ for (const worker of Object.values(cluster.workers)) {
[`.setupPrimary()`]: #clustersetupprimarysettings
[`ChildProcess.send()`]: child_process.md#subprocesssendmessage-sendhandle-options-callback
[`child_process.fork()`]: child_process.md#child_processforkmodulepath-args-options
[`child_process.spawn()`]: child_process.md#child_processspawncommand-args-options
[`child_process` event: `'exit'`]: child_process.md#event-exit
[`child_process` event: `'message'`]: child_process.md#event-message
[`cluster.isPrimary`]: #clusterisprimary
Expand All @@ -1100,5 +1102,6 @@ for (const worker of Object.values(cluster.workers)) {
[`kill()`]: process.md#processkillpid-signal
[`process` event: `'message'`]: process.md#event-message
[`server.close()`]: net.md#event-close
[`stdio`]: child_process.md#optionsstdio
[`worker.exitedAfterDisconnect`]: #workerexitedafterdisconnect
[`worker_threads`]: worker_threads.md

0 comments on commit f2bb191

Please sign in to comment.