Class BaseCluster

Hierarchy

EventEmitter
- BaseCluster
  - Cluster

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseCluster(options?: ClusterNodeOptions[]): BaseCluster

Overrides EventEmitter.constructor
- Defined in base/BaseCluster.ts:21
Parameters
- Optional options: ClusterNodeOptions[]
Returns BaseCluster

Properties

Abstract filter

filter: ClusterFilter

Readonly nodes

nodes: ClusterNode[] = []

Abstract send

send: ClusterSend

Methods

connect

connect(): Promise<void[]>

- Defined in base/BaseCluster.ts:26
Returns Promise<void[]>

get

get(guildID: string): Player<ClusterNode>

- Defined in base/BaseCluster.ts:63
Parameters
- guildID: string
Returns Player<ClusterNode>

getNode

getNode(guildID: string): ClusterNode

- Defined in base/BaseCluster.ts:52
Parameters
- guildID: string
Returns ClusterNode

has

has(guildID: string): boolean

- Defined in base/BaseCluster.ts:59
Parameters
- guildID: string
Returns boolean

sort

sort(): ClusterNode[]

- Defined in base/BaseCluster.ts:40
Returns ClusterNode[]

spawn

spawn(options: ClusterNodeOptions): ClusterNode
spawn(options: ClusterNodeOptions[]): ClusterNode[]

- Defined in base/BaseCluster.ts:30
Parameters
- options: ClusterNodeOptions
Returns ClusterNode
- Defined in base/BaseCluster.ts:31
Parameters
- options: ClusterNodeOptions[]
Returns ClusterNode[]

voiceServerUpdate

voiceServerUpdate(server: GatewayVoiceServerUpdateDispatchData): Promise<boolean>

- Defined in base/BaseCluster.ts:71
Parameters
- server: GatewayVoiceServerUpdateDispatchData
Returns Promise<boolean>

voiceStateUpdate

voiceStateUpdate(state: GatewayVoiceState): Promise<boolean>

- Defined in base/BaseCluster.ts:67
Parameters
- state: GatewayVoiceState
Returns Promise<boolean>

Generated using TypeDoc