ShardingManagerOptions

typedef · Source

The options to spawn shards with for a ShardingManager. Type: Object

Properties

totalShards

optional

totalShards: string | number

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

Default: 'auto'

shardList

optional

shardList: string | Array<number>

List of shards to spawn or "auto"

Default: 'auto'

mode

optional

mode: ShardingManagerMode

Which mode to use for shards

Default: 'process'

respawn

optional

respawn: boolean

Whether shards should automatically respawn upon exiting

Default: true

shardArgs

optional

shardArgs: Array<string>

Arguments to pass to the shard script when spawning (only available when mode is set to 'process')

Default: []

execArgv

optional

execArgv: Array<string>

Arguments to pass to the shard script executable when spawning (only available when mode is set to 'process')

Default: []

token

optional

token: string

Token to use for automatic shard count and passing to shards