Master | discord-rose

Master process controller

Hierarchy

EventEmitter<{ CLUSTER_STARTED: Cluster; CLUSTER_STOPPED: Cluster; DEBUG: string; READY: Master }>
- Master

Index

Constructors

constructor

Properties

Accessors

clusters

Methods

Constructors

constructor

new Master(fileName: string, options: BotOptions): Master

Overrides EventEmitter<{READY: MasterCLUSTER_STARTED: ClusterCLUSTER_STOPPED: ClusterDEBUG: string}>.constructor
- Defined in src/clustering/master/Master.ts:80
Creates a new Master instance

Parameters
- fileName: string
  
  Location of Worker file
- options: BotOptions
  
  Options
Returns Master

Properties

chunks

chunks: number[][] = ...

Chunked Numbers for shards / cluster

fileName

fileName: string

File name to spawn with

handlers

handlers: { emit: <K>(event: K, cluster: Cluster, data: ThreadEvents[K]["send"], resolve: ResolveFunction<K>) => boolean; on: <K>(event: K, listener: (cluster: Cluster, data: ThreadEvents[K]["send"], resolve: ResolveFunction<K>) => void) => any } = ...

Handler emitter

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

Type declaration

emit: <K>(event: K, cluster: Cluster, data: ThreadEvents[K]["send"], resolve: ResolveFunction<K>) => boolean
- - <K>(event: K, cluster: Cluster, data: ThreadEvents[K]["send"], resolve: ResolveFunction<K>): boolean
  - Type parameters
    - K: keyof ThreadEvents
    Parameters
    - event: K
    - cluster: Cluster
    - data: ThreadEvents[K]["send"]
    - resolve: ResolveFunction<K>
    Returns boolean
on: <K>(event: K, listener: (cluster: Cluster, data: ThreadEvents[K]["send"], resolve: ResolveFunction<K>) => void) => any
- - <K>(event: K, listener: (cluster: Cluster, data: ThreadEvents[K]["send"], resolve: ResolveFunction<K>) => void): any
  - Type parameters
    - K: keyof ThreadEvents
    Parameters
    - event: K
    - listener: (cluster: Cluster, data: ThreadEvents[K]["send"], resolve: ResolveFunction<K>) => void
      - (cluster: Cluster, data: ThreadEvents[K]["send"], resolve: ResolveFunction<K>): void
        
        Parameters
        
        cluster: Cluster
        
        data: ThreadEvents[K]["send"]
        
        resolve: ResolveFunction<K>
        
        Returns void
    Returns any

log

log: (msg: string, cluster?: Cluster) => void

Log function

Type declaration

- (msg: string, cluster?: Cluster): void
- Parameters
  - msg: string
  - Optional cluster: Cluster
  Returns void

options

options: CompleteBotOptions

Options

processes

processes: Collection<string, Cluster> = ...

Process list (including custom processes)

rest

rest: RestManager = ...

Rest Manager (only set after running .start())

session

session: APIGatewaySessionStartLimit

Session data (Set after .start())

sharder

sharder: Sharder = ...

Sharding manager for handling shard ratelimits

spawned

spawned: boolean = false

Whether or not the master has been spawned

Accessors

clusters

get clusters(): Collection<string, Cluster>

- Defined in src/clustering/master/Master.ts:119
Get all Discord Bot clusters (discludes custom processes)

Returns Collection<string, Cluster>

Methods

broadcastEval

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

- Defined in src/clustering/master/Master.ts:218
Evals code on every cluster

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

An array of responses

debug

debug(msg: string): void

- Defined in src/clustering/master/Master.ts:112
Parameters
- msg: string
Returns void

getStats

getStats(): Promise<ClusterStats[]>

- Defined in src/clustering/master/Master.ts:226
Gets each clusters stats

Returns Promise<ClusterStats[]>

Stats

guildToCluster

guildToCluster(guildId: string): Cluster

- Defined in src/clustering/master/Master.ts:256
Get a cluster based on the guild that should be cached there

Parameters
- guildId: string
  
  Guild ID
Returns Cluster

Cluster guild belongs to

guildToShard

guildToShard(guildId: string): number

- Defined in src/clustering/master/Master.ts:247
Get the shard that has a certain guild

Parameters
- guildId: string
  
  ID of guild
Returns number

ID of shard

sendToAll

sendToAll<K>(event: K, data: ThreadEvents[K]["send"], all?: boolean): Promise<ThreadEvents[K]["receive"][]>

- Defined in src/clustering/master/Master.ts:198
Sends an event to all clusters

Type parameters
- K: keyof ThreadEvents
Parameters
- event: K
  
  Event name
- data: ThreadEvents[K]["send"]
  
  Event data
- all: boolean = false
  
  Whether or not to send to all processes, including custom ones
Returns Promise<ThreadEvents[K]["receive"][]>

The data sent back

shardToCluster

shardToCluster(shardId: number): Cluster

- Defined in src/clustering/master/Master.ts:235
Convert a shard ID into it's containing cluster

Parameters
- shardId: number
  
  Shard ID to convert to
Returns Cluster

The cluster the shard belongs to

spawnProcess

spawnProcess(name: string, fileName: string): Cluster

- Defined in src/clustering/master/Master.ts:129
Spawns a custom process

Parameters
- name: string
  
  Name of the process (especially for logging)
- fileName: string
  
  Direct path for process
Returns Cluster

The new Cluster thread created

start

start(): Promise<void>

- Defined in src/clustering/master/Master.ts:144
Starts the bot and spawns workers

Returns Promise<void>

tellAll

tellAll<K>(event: K, data: ThreadEvents[K]["send"], all?: boolean): any[]

- Defined in src/clustering/master/Master.ts:209
Sends a TELL event to all clusters

Type parameters
- K: keyof ThreadEvents
Parameters
- event: K
  
  Event name
- data: ThreadEvents[K]["send"]
  
  Event data
- all: boolean = false
  
  Whether or not to send to all processes, including custom ones
Returns any[]

Nothing

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fileName: string

options: BotOptions

Returns Master

Properties

chunks

fileName

handlers

Type declaration

emit: <K>(event: K, cluster: Cluster, data: ThreadEvents[K]["send"], resolve: ResolveFunction<K>) => boolean

Type parameters

K: keyof ThreadEvents

Parameters

event: K

cluster: Cluster

data: ThreadEvents[K]["send"]

resolve: ResolveFunction<K>

Returns boolean

on: <K>(event: K, listener: (cluster: Cluster, data: ThreadEvents[K]["send"], resolve: ResolveFunction<K>) => void) => any

Type parameters

K: keyof ThreadEvents

Parameters

event: K

listener: (cluster: Cluster, data: ThreadEvents[K]["send"], resolve: ResolveFunction<K>) => void

Parameters

cluster: Cluster

data: ThreadEvents[K]["send"]

resolve: ResolveFunction<K>

Returns void

Returns any

log

Type declaration

Parameters

msg: string

Optional cluster: Cluster

Returns void

options

processes

rest

session

sharder

spawned

Accessors

clusters

Returns Collection<string, Cluster>

Methods

broadcastEval

Parameters

code: string

Returns Promise<any[]>

debug

Parameters

msg: string

Returns void

getStats

Returns Promise<ClusterStats[]>

guildToCluster

Parameters

guildId: string

Returns Cluster

guildToShard

Parameters

guildId: string

Returns number

sendToAll

Type parameters

K: keyof ThreadEvents

Parameters

event: K

data: ThreadEvents[K]["send"]

all: boolean = false

Returns Promise<ThreadEvents[K]["receive"][]>