Skip to main content

ClusterSettings

interface ClusterSettings

Deno compatibility

This symbol is a non-functional stub.

Properties Jump to heading

optional
Jump to headingexecArgv: string[] | undefined

List of string arguments passed to the Node.js executable.

optional
Jump to headingexec: string | undefined

File path to worker file.

optional
Jump to headingargs: string[] | undefined

String arguments passed to worker.

optional
Jump to headingsilent: boolean | undefined

Whether or not to send output to parent's stdio.

optional
Jump to headingstdio: any[] | undefined

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. See child_prcess.spawn()'s stdio.

optional
Jump to headinguid: number | undefined

Sets the user identity of the process. (See setuid(2).)

optional
Jump to headinggid: number | undefined

Sets the group identity of the process. (See setgid(2).)

optional
Jump to headinginspectPort:
number
| (() => number)
| undefined

Sets inspector port of worker. This can be a number, or a function that takes no arguments and returns a number. By default each worker gets its own port, incremented from the primary's process.debugPort.

Specify the kind of serialization used for sending messages between processes. Possible values are 'json' and 'advanced'. See Advanced serialization for child_process for more details.

optional
Jump to headingcwd: string | undefined

Current working directory of the worker process.

optional
Jump to headingwindowsHide: boolean | undefined

Hide the forked processes console window that would normally be created on Windows systems.

Back to top