Skip to content

Commit 9d60e38

Browse files
committed
Document getSettings()
1 parent 0929cc4 commit 9d60e38

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

doc/api/cluster.md

+39
Original file line numberDiff line numberDiff line change
@@ -843,6 +843,45 @@ Spawn a new worker process.
843843

844844
This can only be called from the primary process.
845845

846+
## `cluster.getSettings()`
847+
848+
<!-- YAML
849+
added: REPLACEME
850+
-->
851+
852+
* Returns: {Object}
853+
* `execArgv` {string\[]} List of string arguments passed to the Node.js
854+
executable. **Default:** `process.execArgv`.
855+
* `exec` {string} File path to worker file. **Default:** `process.argv[1]`.
856+
* `args` {string\[]} String arguments passed to worker.
857+
**Default:** `process.argv.slice(2)`.
858+
* `cwd` {string} Current working directory of the worker process. **Default:**
859+
`undefined` (inherits from parent process).
860+
* `serialization` {string} Specify the kind of serialization used for sending
861+
messages between processes. Possible values are `'json'` and `'advanced'`.
862+
See [Advanced serialization for `child_process`][] for more details.
863+
**Default:** `false`.
864+
* `schedulingPolicy` {string} Scheduling policy to use between processes.
865+
**Default:** `cluster.SCHED_RR`. See \[`cluster.schedulingPolicy`]\[] for
866+
details.
867+
* `silent` {boolean} Whether or not to send output to parent's stdio.
868+
**Default:** `false`.
869+
* `stdio` {Array} Configures the stdio of forked processes. Because the
870+
cluster module relies on IPC to function, this configuration must contain an
871+
`'ipc'` entry. When this option is provided, it overrides `silent`. See
872+
[`child_process.spawn()`][]'s [`stdio`][].
873+
* `uid` {number} Sets the user identity of the process. (See setuid(2).)
874+
* `gid` {number} Sets the group identity of the process. (See setgid(2).)
875+
* `inspectPort` {number|Function} Sets inspector port of worker.
876+
This can be a number, or a function that takes no arguments and returns a
877+
number. By default each worker gets its own port, incremented from the
878+
primary's `process.debugPort`.
879+
* `windowsHide` {boolean} Hide the forked processes console window that would
880+
normally be created on Windows systems. **Default:** `false`.
881+
882+
After calling [`.setupPrimary()`][] (or [`.fork()`][]) this function will return
883+
the cluster settings, including the default values.
884+
846885
## `cluster.isMaster`
847886

848887
<!-- YAML

0 commit comments

Comments
 (0)