class ShardingManager

extends

EventEmitter
export class ShardingManager extends EventEmitter

This is a utility class that makes multi-process sharding of a bot an easy and painless experience. It works by spawning a self-contained ChildProcess or Worker for each individual shard, each containing its own instance of your bot's Client. They all have a line of communication with the master process, and there are several useful methods that utilize it in order to simplify tasks that are normally difficult with sharding. It can spawn a specific number of shards or the amount that Discord suggests for the bot, and takes a path to your main bot script to launch for each one.

Constructors

constructor(
file: string
options?: ShardingManagerOptions
)

execArgv : Array<string>

An array of arguments to pass to the executable (only when mode is process)

file : string

Path to the shard script file

mode : ShardingManagerMode

Mode for shards to spawn with

respawn : boolean

Whether shards should automatically respawn upon exiting

shardArgs : string[]

An array of arguments to pass to shards (only when mode is process)

shardList : number[] | 'auto'

List of shards this sharding manager spawns

shards : Collection<number, Shard>

A collection of shards that this manager has spawned

silent : boolean

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

token : string | null

Token to use for obtaining the automatic shard count, and passing to shards

totalShards : number | 'auto'

Amount of shards that all sharding managers spawn in total

broadcast(
message: unknown
) : Promise<Shard[]>

Sends a message to all shards.

broadcastEval<

Result

>(
script: (client: Client) => Awaitable<Result>
) : Promise<Serialized<Result>[]>

Evaluates a script on all shards, or a given shard, in the context of the Clients.

Returns: Results of the script execution

createShard(
id: number = this.shards.size
) : Shard

Creates a single shard. Using this method is usually not necessary if you use the spawn method.

Returns: Note that the created shard needs to be explicitly spawned using its spawn method.

fetchClientValues(
prop: string
) : Promise<unknown[]>

Fetches a client property value of each shard, or a given shard.

Examples:
manager.fetchClientValues('guilds.cache.size')
  .then(results => console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`))
  .catch(console.error);

on(
event: 'shardCreate'
listener: (shard: Shard) => void
) : this

once(
event: 'shardCreate'
listener: (shard: Shard) => void
) : this

respawnAll(
options?: MultipleShardRespawnOptions
) : Promise<Collection<number, Shard>>

Kills all running shards and respawns them.

spawn(
options?: MultipleShardSpawnOptions
) : Promise<Collection<number, Shard>>

Spawns multiple shards.

shardCreate(
shard: Shard
)

Emitted upon creating a shard.