Skip to main content
ClusterSettings - cluster - Node documentation
interface ClusterSettings

Usage in Deno

import { type ClusterSettings } from "node:cluster";

Deno compatibility

This symbol is a non-functional stub.

Properties

optional
execArgv: string[] | undefined

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

optional
exec: string | undefined

File path to worker file.

optional
args: string[] | undefined

String arguments passed to worker.

optional
silent: boolean | undefined

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

optional
stdio: 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
uid: number | undefined

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

optional
gid: number | undefined

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

optional
inspectPort:
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.

optional
serialization: SerializationType | undefined

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
cwd: string | undefined

Current working directory of the worker process.

optional
windowsHide: boolean | undefined

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