Interface ClusterManagerOptions<T>

interface ClusterManagerOptions<T> {
    autoRespawn?: boolean;
    cluster?: T extends "fork"
        ? ForkOptions
        : WorkerOptions;
    clusterCount?: number;
    execArgv?: any[];
    mode?: T;
    queueAutoSpawn?: boolean;
    queueTimeout?: number;
    server: ServerClientOptions;
    shardArgs?: any[];
    shardsPerCluster?: number;
    spawnDelay?: number;
    spawnTimeout?: number;
}

Type Parameters

Properties

autoRespawn? cluster? clusterCount? execArgv? mode? queueAutoSpawn? queueTimeout? server shardArgs? shardsPerCluster? spawnDelay? spawnTimeout?

Properties

Optional autoRespawn

autoRespawn?: boolean

Whether to automatically respawn dead clusters.

Optional cluster

cluster?: T extends "fork"
    ? ForkOptions
    : WorkerOptions

Optional clusterCount

clusterCount?: number

Total number of clusters.

Optional execArgv

execArgv?: any[]

Exec args.

Optional mode

mode?: T

Mode of the cluster manager.

Optional queueAutoSpawn

queueAutoSpawn?: boolean

Whether to automatically spawn clusters in the queue.

Optional queueTimeout

queueTimeout?: number

Queue spawn timeout.

server

server: ServerClientOptions

Server options.

Optional shardArgs

shardArgs?: any[]

Shard args.

Optional shardsPerCluster

shardsPerCluster?: number

Number of shards per cluster.

Optional spawnDelay

spawnDelay?: number

Time to wait before spawning a new cluster.

Optional spawnTimeout

spawnTimeout?: number

Spawn timeout of clusters.

Settings

Member Visibility

Theme

On This Page

autoRespawnclusterclusterCountexecArgvmodequeueAutoSpawnqueueTimeoutservershardArgsshardsPerClusterspawnDelayspawnTimeout

Generated using TypeDoc