Class BotShard

Creates and handles the communication of a shard

Hierarchy

BotShard

Index

Constructors

constructor

Properties

id
state

Methods

Constructors

constructor

new BotShard(manager: BotShardManager, id: ShardId): BotShard

- Defined in src/sharding/BotShard.ts:39
Parameters
- manager: BotShardManager
- id: ShardId
Returns BotShard

Properties

Readonly id

state

state: BotShardState

Methods

communicate

communicate(event: string): Promise<Serializable>

- Defined in src/sharding/BotShard.ts:132
Sends a message to the child process in order to emit a registered given event

Parameters
- event: string
  
  The event to be emitted in the child process
Returns Promise<Serializable>

disconnect

disconnect(code: GatewayCloseCode): void

- Defined in src/sharding/BotShard.ts:185
Disconnects this shard

Parameters
- code: GatewayCloseCode
  
  The shard close code
Returns void

emitEvent

emitEvent<E>(event: E, args: Arguments<Events[E]>): void

- Defined in src/sharding/BotShard.ts:168
Sends the child process a message to emit the given event to EventsHandler

Type parameters
- E: keyof Events
Parameters
- event: E
  
  The event to be emitted
- args: Arguments<Events[E]>
  
  The arguments of the events
Returns void

onMessage

onMessage(request: ShardBroadcastRequest | ShardSendRequest | ShardChangedStateRequest | ShardDisconnectAllRequest): Promise<void>

- Defined in src/sharding/BotShard.ts:69
Listener for child process messages

Parameters
- request: ShardBroadcastRequest | ShardSendRequest | ShardChangedStateRequest | ShardDisconnectAllRequest
  
  The request received from the child process
Returns Promise<void>

spawn

spawn(): void

- Defined in src/sharding/BotShard.ts:53
Spawns a new child according to the given file path. Sets the environmental variables for the process with the sharding information

Returns void

Generated using TypeDoc