Cluster | discord-rose

Cluster utility for working with the thread from the master process

Hierarchy

ThreadComms
- Cluster

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Cluster(id: string, master: Master, fileName?: string, custom?: boolean): Cluster

Overrides ThreadComms.constructor
- Defined in src/clustering/master/Cluster.ts:27
Parameters
- id: string
- master: Master
- fileName: string = ...
- custom: boolean = false
Returns Cluster

Properties

custom

custom: boolean = false

dying

dying: boolean = false

Whether or not the Cluster shouldn't restart

fileName

fileName: string = ...

id

id: string

master

master: Master

spawned

spawned: boolean = false

Whether or not the cluster has been spawned before

started

started: boolean = false

Whether or not the Cluster is currently online

Methods

_emit

_emit<K>(event: K, data: ThreadCommsEventEmitter[K], resolve: ResolveFunction<K>): boolean

Inherited from ThreadComms._emit
- Defined in src/clustering/ThreadComms.ts:164
Type parameters
- K: keyof ThreadEvents
Parameters
- event: K
- data: ThreadCommsEventEmitter[K]
- resolve: ResolveFunction<K>
Returns boolean

eval

eval(code: string): Promise<any[]>

- Defined in src/clustering/master/Cluster.ts:144
Evals code on the cluster

Parameters
- code: string
  
  Code to eval
Returns Promise<any[]>

getGuild

getGuild(id: string): Promise<APIGuild>

- Defined in src/clustering/master/Cluster.ts:136
Gets a guild from the clusters cache

Parameters
- id: string
  
  ID of guild
Returns Promise<APIGuild>

kill

kill(): void

- Defined in src/clustering/master/Cluster.ts:116
Kills cluster without restarting

Returns void

logAs

logAs(msg: string): void

- Defined in src/clustering/master/Cluster.ts:98
Parameters
- msg: string
Returns void

register

register(comms: Worker | MessagePort): void

Inherited from ThreadComms.register
- Defined in src/clustering/ThreadComms.ts:174
Parameters
- comms: Worker | MessagePort
Returns void

restart

restart(): void

- Defined in src/clustering/master/Cluster.ts:105
Restarts the cluster

Returns void

restartShard

restartShard(id: number): void

- Defined in src/clustering/master/Cluster.ts:128
Restarts a shard

Parameters
- id: number
  
  ID of shard to restart
Returns void

sendCommand

sendCommand<K>(event: K, data: ThreadEvents[K]["send"]): Promise<ThreadEvents[K]["receive"]>

Inherited from ThreadComms.sendCommand
- Defined in src/clustering/ThreadComms.ts:217
Sends a command to the master

link

https://github.com/discord-rose/discord-rose/wiki/Using-Clusters#creating-custom-events

Type parameters
- K: keyof ThreadEvents
Parameters
- event: K
  
  Event to send
- data: ThreadEvents[K]["send"]
  
  Data to send along
Returns Promise<ThreadEvents[K]["receive"]>

Data back

spawn

spawn(): Promise<void>

- Defined in src/clustering/master/Cluster.ts:37
Returns Promise<void>

start

start(): Promise<undefined | {}>

- Defined in src/clustering/master/Cluster.ts:80
Returns Promise<undefined | {}>

tell

tell<K>(event: K, data: ThreadEvents[K]["send"]): void

Inherited from ThreadComms.tell
- Defined in src/clustering/ThreadComms.ts:247
Tells the master something

link

https://github.com/discord-rose/discord-rose/wiki/Using-Clusters#creating-custom-events

Type parameters
- K: keyof ThreadEvents
Parameters
- event: K
  
  Event to send
- data: ThreadEvents[K]["send"]
  
  Data to send
Returns void

Generated using TypeDoc