interface ClusterSettings

Deno compatibility

This symbol is a non-functional stub.

Properties #

#execArgv: string[] | undefined

optional

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

#exec: string | undefined

optional

File path to worker file.

#args: string[] | undefined

optional

String arguments passed to worker.

#silent: boolean | undefined

optional

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

#stdio: any[] | undefined

optional

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.

#uid: number | undefined

optional

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

#gid: number | undefined

optional

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

#inspectPort: number
 | (() => number)
 | undefined

optional

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.

#serialization: SerializationType | undefined

optional

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.

#cwd: string | undefined

optional

Current working directory of the worker process.

#windowsHide: boolean | undefined

optional

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