interface ShardingManagerOptions

export interface ShardingManagerOptions

The options to spawn shards with for a ShardingManager.

optional
execArgv? : readonly string[] = []

Arguments to pass to the shard script executable when spawning

optional
mode? : ShardingManagerMode = 'process'

Which mode to use for shards

optional
respawn? : boolean = true

Whether shards should automatically respawn upon exiting

optional
shardArgs? : readonly string[] = []

Arguments to pass to the shard script when spawning

optional
shardList? : readonly number[] | 'auto' = 'auto'

List of shards to spawn or "auto"

optional
silent? : boolean

Whether to pass the silent flag to child process (only available when mode is set to 'process')

optional
token? : string

Token to use for automatic shard count and passing to shards

optional
totalShards? : number | 'auto' = 'auto'

Number of total shards of all shard managers or "auto"