Thread | discord-rose

Thread interface for interacting with the master process from a worker

Hierarchy

ThreadComms
- Thread

Index

Constructors

constructor

Properties

id
worker

Methods

Constructors

constructor

new Thread(worker?: Worker, register?: boolean): Thread

Overrides ThreadComms.constructor
- Defined in src/clustering/worker/Thread.ts:16
Parameters
- worker: Worker = ...
- register: boolean = true
Returns Thread

Properties

id

id: string

worker

worker: Worker = ...

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

broadcastEval

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

- Defined in src/clustering/worker/Thread.ts:87
Eval code on every cluster

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

Response

destroy

destroy(): void

- Defined in src/clustering/worker/Thread.ts:45
Destroys entire master.

Returns void

getGuild

getGuild(guildId: string): Promise<APIGuild>

- Defined in src/clustering/worker/Thread.ts:78
Gets a cached guild across clusters

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

The guild

getStats

getStats(): Promise<ClusterStats[]>

- Defined in src/clustering/worker/Thread.ts:115
Gets an array of each clusters stats

Returns Promise<ClusterStats[]>

Stats

log

log(...messages: any[]): void

- Defined in src/clustering/worker/Thread.ts:53
Logs data to master's MasterOptions.log

Parameters
- Rest ...messages: any[]
Returns void

masterEval

masterEval(code: string): Promise<any>

- Defined in src/clustering/worker/Thread.ts:96
Evals code on the master process

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

Response

register

register(comms: Worker | MessagePort): void

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

registerShard

registerShard(id: number): Promise<{}>

- Defined in src/clustering/worker/Thread.ts:38
Parameters
- id: number
Returns Promise<{}>

restartCluster

restartCluster(clusterId: string): void

- Defined in src/clustering/worker/Thread.ts:61
Restarts a specific cluster

Parameters
- clusterId: string
  
  ID of cluster
Returns void

restartShard

restartShard(shardId: any): void

- Defined in src/clustering/worker/Thread.ts:69
Restarts a specific shard

Parameters
- shardId: any
  
  ID of shard
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

sendWebhook

sendWebhook(webhookId: string, token: string, data: MessageTypes): Promise<APIMessage>

- Defined in src/clustering/worker/Thread.ts:107
Sends a webhook using the master process, useful for respecting ratelimits

Parameters
- webhookId: string
  
  ID of webhook
- token: string
  
  Token of webhook
- data: MessageTypes
  
  Data for message
Returns Promise<APIMessage>

Message sent

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