From f2bb1919e5815666e6ba6d765ff8b5edcf8a796b Mon Sep 17 00:00:00 2001 From: Kumar Arnav <36244620+Karnav123@users.noreply.github.com> Date: Tue, 30 May 2023 11:40:58 +0530 Subject: [PATCH] doc: improve the documentation of the stdio option Fixes: https://github.com/nodejs/node/issues/47705 PR-URL: https://github.com/nodejs/node/pull/48110 Refs: https://nodejs.org/docs/latest-v20.x/api/cluster.html#clustersettings Reviewed-By: Luigi Pinca Reviewed-By: James M Snell --- doc/api/cluster.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/api/cluster.md b/doc/api/cluster.md index 7ab57b02a5a262..aa2e9b4057e5fc 100644 --- a/doc/api/cluster.md +++ b/doc/api/cluster.md @@ -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. @@ -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 @@ -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