Skip to content

ShardManager

Defined in: packages/sharding/src/index.ts:310

Manages independent Discord Gateway shards with explicit destruction and reinitialization semantics.

new ShardManager(options): ShardManager

Defined in: packages/sharding/src/index.ts:356

Creates a shard manager.

ShardManagerOptions

Sharding configuration.

ShardManager

If token or intents are invalid.

If shard count is invalid.

readonly shards: Map<number, Gateway>

Defined in: packages/sharding/src/index.ts:314

Active Gateway shards indexed by shard identifier.


readonly static IDENTIFY_INTERVAL: 5000 = 5000

Defined in: packages/sharding/src/index.ts:312

Discord’s minimum interval between IDENTIFY payloads, in milliseconds.

get shardCount(): number

Defined in: packages/sharding/src/index.ts:316

Total shards in the deployment once initialized, 0 before and after destroy().

number


get shardIds(): number[]

Defined in: packages/sharding/src/index.ts:320

IDs of the shards this manager owns.

number[]

addShards(shardIds): Promise<void>

Defined in: packages/sharding/src/index.ts:541

Takes over more shards of the same deployment (recovery after another cluster gave up) and connects them through the same IDENTIFY path.

readonly number[]

Promise<void>

If an ID is invalid, already owned, or the manager is not initialized.


checkAutoScale(): Promise<void>

Defined in: packages/sharding/src/index.ts:703

Checks if the recommended shard count has changed and reconnects if so.

Promise<void>


connect(): Promise<void>

Defined in: packages/sharding/src/index.ts:511

Connects all shards sequentially. A destroyed manager is reinitialized before connecting.

Promise<void>

A promise fulfilled after all shards connect.

If a shard fails to connect.


destroy(): void

Defined in: packages/sharding/src/index.ts:723

Permanently closes the current shard set and releases Gateway resources. The next connect recreates them.

void

Nothing.


fetchGatewayInfo(): Promise<GatewayBotInfo>

Defined in: packages/sharding/src/index.ts:505

Retrieves /gateway/bot: recommended shards and the IDENTIFY budget. Remembered for pacing the next connect.

Promise<GatewayBotInfo>

If discovery fails or returns invalid data.


fetchRecommendedShardCount(): Promise<number>

Defined in: packages/sharding/src/index.ts:497

Retrieves Discord’s recommended shard count.

Promise<number>

Recommended shard count.

If discovery fails or returns invalid data.


get(id): Gateway | undefined

Defined in: packages/sharding/src/index.ts:786

Gets a shard by ID.

number

Shard identifier.

Gateway | undefined

Gateway instance or undefined.


getShardIdForGuild(guildId): number

Defined in: packages/sharding/src/index.ts:769

Calculates the target shard ID for a Discord guild snowflake.

string

Guild snowflake.

number

Shard identifier.


health(): ShardHealth[]

Defined in: packages/sharding/src/index.ts:790

Returns each shard’s connection state, lifecycle status and heartbeat latency.

ShardHealth[]


off<E>(event, listener): this

Defined in: packages/sharding/src/index.ts:748

Stops listening for a shard event.

E extends keyof ShardManagerEvents

E

(…args) => void

this

This manager.


on<E>(event, listener): this

Defined in: packages/sharding/src/index.ts:738

Listens for an aggregated shard event.

E extends keyof ShardManagerEvents

E

(…args) => void

this

This manager.


report(metrics?): WorkerReport

Defined in: packages/sharding/src/index.ts:808

A health report for the parent: shard health and, on request, process metrics.

boolean = false

WorkerReport


reshard(count): Promise<void>

Defined in: packages/sharding/src/index.ts:717

Forces a reshard to a new shard count, replacing all active shards.

number

New shard count.

Promise<void>


sendVoiceState(guildId, channelId, options?): boolean

Defined in: packages/sharding/src/index.ts:774

Sends a voice state update (op 4) on the shard that owns the guild.

string

string | null

boolean

boolean

boolean

Whether it was sent; false if that shard is absent or disconnected.


values(): ShardInfo[]

Defined in: packages/sharding/src/index.ts:847

Returns information for all managed shards.

ShardInfo[]

Shard information snapshots.