Class BotShardManager

Creates and manages all bot shards

Hierarchy

BotShardManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BotShardManager(file: string, token: string, shardsAmount: number): BotShardManager

- Defined in src/sharding/BotShardManager.ts:16
Parameters
- file: string
- token: string
- shardsAmount: number
Returns BotShardManager

Properties

Readonly file

file: string

Readonly shardsAmount

shardsAmount: number

Methods

broadcast

broadcast(event: string): Promise<Serializable[]>

- Defined in src/sharding/BotShardManager.ts:46
Emits an event on all shards initiated with this manager

Parameters
- event: string
  
  The event to be emitted
Returns Promise<Serializable[]>

checkShardsState

checkShardsState(state: BotShardState): boolean

- Defined in src/sharding/BotShardManager.ts:87
Checks if all shards under this manager match the given state

Parameters
- state: BotShardState
  
  The state to check if all shards match
Returns boolean

Whether all shards match that state

disconnectAll

disconnectAll(code: GatewayCloseCode): void

- Defined in src/sharding/BotShardManager.ts:95
Disconnects all active shards under this manager

Parameters
- code: GatewayCloseCode
  
  The shards' close code
Returns void

emitEvent

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

- Defined in src/sharding/BotShardManager.ts:61
Emits a given event on all shards under this manager

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

send

send(event: string, shardId: ShardId): Promise<Serializable> | undefined

- Defined in src/sharding/BotShardManager.ts:74
Emits an event on a specific shard. Returns undefined if no shard matching the given ID was found

Parameters
- event: string
  
  The event to be emitted
- shardId: ShardId
  
  The ID of the shard where this event should be emitted
Returns Promise<Serializable> | undefined

start

start(): Promise<void>

- Defined in src/sharding/BotShardManager.ts:30
Starts the shards and stores them inside a Collection

Returns Promise<void>

Generated using TypeDoc