Cluster | typescript

Hierarchy

EventEmitter
- Cluster

Index

Constructors

constructor

Properties

Constructors

constructor

new Cluster(options?: EventEmitterOptions): Cluster

Inherited from EventEmitter.constructor
- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- Optional options: EventEmitterOptions
Returns Cluster

Properties

SCHED_NONE

SCHED_NONE: number

SCHED_RR

SCHED_RR: number

Worker

Worker: Worker

isMaster

isMaster: boolean

isWorker

isWorker: boolean

schedulingPolicy

schedulingPolicy: number

settings

settings: ClusterSettings

Optional worker

worker: Worker

Optional workers

workers: Dict<Worker>

Static captureRejectionSymbol

captureRejectionSymbol: keyof symbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static errorMonitor

errorMonitor: keyof symbol

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.

Methods

addListener

addListener(event: string, listener: function): this
addListener(event: "disconnect", listener: function): this
addListener(event: "exit", listener: function): this
addListener(event: "fork", listener: function): this
addListener(event: "listening", listener: function): this
addListener(event: "message", listener: function): this
addListener(event: "online", listener: function): this
addListener(event: "setup", listener: function): this

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/cluster.d.ts:122
events.EventEmitter
1. disconnect
2. exit
3. fork
4. listening
5. message
6. online
7. setup
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/cluster.d.ts:123
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/cluster.d.ts:124
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/cluster.d.ts:125
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/cluster.d.ts:126
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/cluster.d.ts:127
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/cluster.d.ts:128
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/cluster.d.ts:129
Parameters
- event: "setup"
- listener: function
  - - (settings: ClusterSettings): void
    - Parameters
      - settings: ClusterSettings
      Returns void
Returns this

disconnect

disconnect(callback?: function): void

- Defined in node_modules/@types/node/cluster.d.ts:99
Parameters
- Optional callback: function
  - - (): void
    - Returns void
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean
emit(event: "disconnect", worker: Worker): boolean
emit(event: "exit", worker: Worker, code: number, signal: string): boolean
emit(event: "fork", worker: Worker): boolean
emit(event: "listening", worker: Worker, address: Address): boolean
emit(event: "message", worker: Worker, message: any, handle: Socket | Server): boolean
emit(event: "online", worker: Worker): boolean
emit(event: "setup", settings: ClusterSettings): boolean

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/cluster.d.ts:131
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/cluster.d.ts:132
Parameters
- event: "disconnect"
- worker: Worker
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/cluster.d.ts:133
Parameters
- event: "exit"
- worker: Worker
- code: number
- signal: string
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/cluster.d.ts:134
Parameters
- event: "fork"
- worker: Worker
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/cluster.d.ts:135
Parameters
- event: "listening"
- worker: Worker
- address: Address
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/cluster.d.ts:136
Parameters
- event: "message"
- worker: Worker
- message: any
- handle: Socket | Server
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/cluster.d.ts:137
Parameters
- event: "online"
- worker: Worker
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/cluster.d.ts:138
Parameters
- event: "setup"
- settings: ClusterSettings
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

fork

fork(env?: any): Worker

- Defined in node_modules/@types/node/cluster.d.ts:100
Parameters
- Optional env: any
Returns Worker

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string, listener: function): this
on(event: "disconnect", listener: function): this
on(event: "exit", listener: function): this
on(event: "fork", listener: function): this
on(event: "listening", listener: function): this
on(event: "message", listener: function): this
on(event: "online", listener: function): this
on(event: "setup", listener: function): this

Overrides EventEmitter.on
- Defined in node_modules/@types/node/cluster.d.ts:140
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/cluster.d.ts:141
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/cluster.d.ts:142
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/cluster.d.ts:143
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/cluster.d.ts:144
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/cluster.d.ts:145
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/cluster.d.ts:146
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/cluster.d.ts:147
Parameters
- event: "setup"
- listener: function
  - - (settings: ClusterSettings): void
    - Parameters
      - settings: ClusterSettings
      Returns void
Returns this

once

once(event: string, listener: function): this
once(event: "disconnect", listener: function): this
once(event: "exit", listener: function): this
once(event: "fork", listener: function): this
once(event: "listening", listener: function): this
once(event: "message", listener: function): this
once(event: "online", listener: function): this
once(event: "setup", listener: function): this

Overrides EventEmitter.once
- Defined in node_modules/@types/node/cluster.d.ts:149
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/cluster.d.ts:150
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/cluster.d.ts:151
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/cluster.d.ts:152
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/cluster.d.ts:153
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/cluster.d.ts:154
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/cluster.d.ts:155
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/cluster.d.ts:156
Parameters
- event: "setup"
- listener: function
  - - (settings: ClusterSettings): void
    - Parameters
      - settings: ClusterSettings
      Returns void
Returns this

prependListener

prependListener(event: string, listener: function): this
prependListener(event: "disconnect", listener: function): this
prependListener(event: "exit", listener: function): this
prependListener(event: "fork", listener: function): this
prependListener(event: "listening", listener: function): this
prependListener(event: "message", listener: function): this
prependListener(event: "online", listener: function): this
prependListener(event: "setup", listener: function): this

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/cluster.d.ts:158
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/cluster.d.ts:159
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/cluster.d.ts:160
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/cluster.d.ts:161
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/cluster.d.ts:162
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/cluster.d.ts:163
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/cluster.d.ts:164
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/cluster.d.ts:165
Parameters
- event: "setup"
- listener: function
  - - (settings: ClusterSettings): void
    - Parameters
      - settings: ClusterSettings
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string, listener: function): this
prependOnceListener(event: "disconnect", listener: function): this
prependOnceListener(event: "exit", listener: function): this
prependOnceListener(event: "fork", listener: function): this
prependOnceListener(event: "listening", listener: function): this
prependOnceListener(event: "message", listener: function): this
prependOnceListener(event: "online", listener: function): this
prependOnceListener(event: "setup", listener: function): this

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/cluster.d.ts:167
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/cluster.d.ts:168
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/cluster.d.ts:169
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/cluster.d.ts:170
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/cluster.d.ts:171
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/cluster.d.ts:173
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/cluster.d.ts:174
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/cluster.d.ts:175
Parameters
- event: "setup"
- listener: function
  - - (settings: ClusterSettings): void
    - Parameters
      - settings: ClusterSettings
      Returns void
Returns this

rawListeners

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

Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

setupMaster

setupMaster(settings?: ClusterSettings): void

- Defined in node_modules/@types/node/cluster.d.ts:105
Parameters
- Optional settings: ClusterSettings
Returns void

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:31
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

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

Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:28
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

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

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: EventEmitterOptions

Returns Cluster

Properties

SCHED_NONE

SCHED_RR

Worker

isMaster

isWorker

schedulingPolicy

settings

Optional worker

Optional workers

Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static errorMonitor

Methods

addListener

Parameters

event: string

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

Parameters

event: "disconnect"

listener: function

Parameters

worker: Worker

Returns void

Returns this

Parameters

event: "exit"

listener: function

Parameters

worker: Worker

code: number

signal: string

Returns void

Returns this

Parameters

event: "fork"

listener: function

Parameters

worker: Worker

Returns void

Returns this

Parameters

event: "listening"

listener: function

Parameters

worker: Worker

address: Address

Returns void

Returns this

Parameters

event: "message"

listener: function

Parameters

worker: Worker

message: any

handle: Socket | Server

Returns void

Returns this

Parameters

event: "online"

listener: function

Parameters

worker: Worker

Returns void

Returns this