Commit 8c53386
doc: improve the documentation of the stdio option
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>1 parent 13930f0 commit 8c53386
1 file changed
Lines changed: 4 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -935,7 +935,8 @@ changes: | |||
| 935 | 935 | **Default:** `false`. | |
| 936 | 936 | * `stdio` {Array} Configures the stdio of forked processes. Because the | |
| 937 | 937 | 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`][]. | ||
| 939 | 940 | * `uid` {number} Sets the user identity of the process. (See setuid(2).) | |
| 940 | 941 | * `gid` {number} Sets the group identity of the process. (See setgid(2).) | |
| 941 | 942 | * `inspectPort` {number|Function} Sets inspector port of worker. | |
@@ -1092,6 +1093,7 @@ for (const worker of Object.values(cluster.workers)) { | |||
| 1092 | 1093 | [`.setupPrimary()`]: #clustersetupprimarysettings | |
| 1093 | 1094 | [`ChildProcess.send()`]: child_process.md#subprocesssendmessage-sendhandle-options-callback | |
| 1094 | 1095 | [`child_process.fork()`]: child_process.md#child_processforkmodulepath-args-options | |
| 1096 | + [`child_process.spawn()`]: child_process.md#child_processspawncommand-args-options | ||
| 1095 | 1097 | [`child_process` event: `'exit'`]: child_process.md#event-exit | |
| 1096 | 1098 | [`child_process` event: `'message'`]: child_process.md#event-message | |
| 1097 | 1099 | [`cluster.isPrimary`]: #clusterisprimary | |
@@ -1100,5 +1102,6 @@ for (const worker of Object.values(cluster.workers)) { | |||
| 1100 | 1102 | [`kill()`]: process.md#processkillpid-signal | |
| 1101 | 1103 | [`process` event: `'message'`]: process.md#event-message | |
| 1102 | 1104 | [`server.close()`]: net.md#event-close | |
| 1105 | + [`stdio`]: child_process.md#optionsstdio | ||
| 1103 | 1106 | [`worker.exitedAfterDisconnect`]: #workerexitedafterdisconnect | |
| 1104 | 1107 | [`worker_threads`]: worker_threads.md | |
0 commit comments