discord.js | Shard

Search...

Shard

export class Shard extends EventEmitter

export class Shard extends EventEmitter

A self-contained shard created by the ShardingManager. Each one has a that contains an instance of the bot and its Client. When its child process/worker exits for any reason, the shard will spawn a new one to replace it as necessary.

Extends

EventEmitter

death

Emitted upon the shard's child process/worker exiting.

Name	Type	Optional	Description
process	ChildProcess \| Worker	No	Child process/worker that exited

disconnect

Emitted upon the shard's shardDisconnect event.

message

Emitted upon receiving a message from the child process/worker.

Name	Type	Optional	Description
message	any	No	Message that was received

reconnecting

Emitted upon the shard's shardReconnecting event.

resume

Emitted upon the shard's shardResume event.

spawn

Emitted upon the creation of the shard's child process/worker.

Name	Type	Optional	Description
process	ChildProcess \| Worker	No	Child process/worker that was created

args:string[]

Arguments for the shard's process/worker

env:unknown

Environment variables for the shard's process, or workerData for the shard's worker

execArgv:string[]

Arguments for the shard's process/worker executable

id:number

The shard's id in the manager

manager:ShardingManager

Manager that created the shard

process:ChildProcess | null

Process of the shard (if mode is process)

ready:boolean

Whether the shard's Client is ready

silent:boolean

Whether to pass silent flag to the shard's process (only when mode is process)

worker:Worker | null

Worker of the shard (if mode is worker)

eval(script):Promise<unknown>

Evaluates a script or function on the shard, in the context of the Client.

Returns

Result of the script execution

Name	Type	Optional	Description
script	string	No	JavaScript to run on the shard

fetchClientValue(prop):Promise<unknown>

Fetches a client property value of the shard.

Example

shard.fetchClientValue('guilds.cache.size')
  .then(count => console.log(`${count} guilds in shard ${shard.id}`))
  .catch(console.error);

shard.fetchClientValue('guilds.cache.size')
  .then(count => console.log(`${count} guilds in shard ${shard.id}`))
  .catch(console.error);

Name	Type	Optional	Description
prop	string	No	Name of the client property to get, using periods for nesting

kill():void

Immediately kills the shard's process/worker and does not restart it.

on(event, listener):this

Name	Type	Optional	Description
event	Event	No	None
listener	(...args: ShardEventTypes[Event]) => void	No	None

once(event, listener):this

Name	Type	Optional	Description
event	Event	No	None
listener	(...args: ShardEventTypes[Event]) => void	No	None

respawn(options?):Promise<ChildProcess>

Kills and restarts the shard's process/worker.

Name	Type	Optional	Description
options	{ delay?: number; timeout?: number }	Yes	Options for respawning the shard

send(message):Promise<Shard>

Sends a message to the shard's process/worker.

Name	Type	Optional	Description
message	unknown	No	Message to send to the shard

spawn(timeout?):Promise<ChildProcess>

Forks a child process or creates a worker thread for the shard. You should not need to call this manually.

Name	Type	Optional	Description
timeout	number	Yes	The amount in milliseconds to wait until the Client has become ready before resolving (`-1` or `Infinity` for no wait)