Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClusterManager

Hierarchy

  • EventSpewer
    • ClusterManager

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

buckets

buckets: BaseCollection<number, Bucket> = ...

file

file: string

maxConcurrency

maxConcurrency: number = 1

processes

processes: BaseCollection<number, ClusterProcess> = ...

ran

ran: boolean = false

respawn

respawn: boolean = true

rest

rest: Client

restCache

restCache: BaseCollection<string | number, ClusterManagerRestCachePayload> = ...

shardCount

shardCount: number = 0

shardEnd

shardEnd: number = -1

shardStart

shardStart: number = 0

shardsPerCluster

shardsPerCluster: number = 4

token

token: string

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

clusterCount

  • get clusterCount(): number

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): ClusterManager

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClusterManager

broadcast

  • broadcast(message: any): Promise<any[]>

broadcastEval

  • broadcastEval(code: string | Function, nonce?: string): Promise<any[]>

broadcastEvalRaw

  • broadcastEvalRaw(code: string | Function, nonce?: string): Promise<[any, boolean][]>

  • Parameters

    • code: string | Function
    • nonce: string = ...

    Returns Promise<[any, boolean][]>

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getRatelimitKey

  • getRatelimitKey(shardId: number): number

hasEventListener

  • hasEventListener(name: string | symbol): boolean

  • Parameters

    • name: string | symbol

    Returns boolean

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): ClusterManager

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClusterManager

on

once

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): ClusterManager

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClusterManager

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): ClusterManager

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClusterManager

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • Parameters

    • Optional name: string | symbol

    Returns ClusterManager

removeAllSubscriptions

  • Returns ClusterManager

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): ClusterManager

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClusterManager

removeSubscription

  • removeSubscription(subscription: EventSubscription): void

  • Parameters

    • subscription: EventSubscription

    Returns void

run

setMaxListeners

  • Parameters

    • n: number

    Returns ClusterManager

subscribe

  • subscribe(event: string | symbol, listener: (...args: any[]) => void): EventSubscription
  • subscribe(event: CLUSTER_PROCESS, listener: (payload: { clusterProcess: ClusterProcess }) => any): EventSubscription
  • subscribe(event: "clusterProcess", listener: (payload: { clusterProcess: ClusterProcess }) => any): EventSubscription

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc