Class Cluster

Hierarchy

TypedEmitter<ClusterEvents>
- Cluster

Implements

Manager

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Cluster(options: ClusterOptions): Cluster

Overrides TypedEmitter<ClusterEvents>.constructor
- Defined in lib/cluster/Cluster.ts:17
Parameters
- options: ClusterOptions
Returns Cluster

Properties

Readonly nodes

nodes: Map<String, ClusterNode>

Readonly sendGatewayPayload

sendGatewayPayload: SendGatewayPayload

Optional userId

userId: string

Accessors

idealNodes

get idealNodes(): ClusterNode[]

- Defined in lib/cluster/Cluster.ts:30
Returns ClusterNode[]

rest

get rest(): REST

- Defined in lib/cluster/Cluster.ts:26
Returns REST

Methods

connect

connect(user?: undefined | string | DiscordResource): void

- Defined in lib/cluster/Cluster.ts:36
Parameters
- user: undefined | string | DiscordResource = ...
Returns void

createPlayer

createPlayer(guild: string | DiscordResource, nodeId?: string): Player<ClusterNode>

- Defined in lib/cluster/Cluster.ts:41
Parameters
- guild: string | DiscordResource
- Optional nodeId: string
Returns Player<ClusterNode>

destroyPlayer

destroyPlayer(guild: string | DiscordResource): boolean

- Defined in lib/cluster/Cluster.ts:47
Parameters
- guild: string | DiscordResource
Returns boolean

getNode

getNode(guild: string | DiscordResource): null | ClusterNode

- Defined in lib/cluster/Cluster.ts:55
Parameters
- guild: string | DiscordResource
Returns null | ClusterNode

handleVoiceUpdate

handleVoiceUpdate(update: VoiceStateUpdate | VoiceServerUpdate): void

- Defined in lib/cluster/Cluster.ts:51
Parameters
- update: VoiceStateUpdate | VoiceServerUpdate
Returns void

Generated using TypeDoc