Skip to main content

ClusterPartial

The main hub for interacting with different clusters.

Constructor​

new ClusterPartial(client);
PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
clientClient❌undefinedDJSeed Client Instance.

Methods​

id READONLY​

Current cluster id.

Type: number

totalShards READONLY​

Total shards across all clusters.

Type: number

firstShard READONLY​

ID of first shard on current cluster.

Type: number

lastShard READONLY​

ID of last shard on current cluster.

Type: number

totalClusters READONLY​

Total amount of cluster currently open.

Type: number

ipc READONLY​

Class containing methods to easily interact with other clusters.

Type: IPC

events READONLY​

One way events from other clusters.

Type: Events

util READONLY​

Class containing helpful utility methods.

Type: Util

Methods​

start​

Used to start cluster.

danger

You do not need to call this! This method is for ClusterUtil

Returns​

void