"cluster" | typescript

Index

Classes

Worker

Interfaces

Variables

Functions

Variables

Const SCHED_NONE

SCHED_NONE: number

Const SCHED_RR

SCHED_RR: number

Const isMaster

isMaster: boolean

Const isWorker

isWorker: boolean

Let schedulingPolicy

schedulingPolicy: number

Const settings

settings: ClusterSettings

Const worker

worker: Worker

Const workers

workers: Dict<Worker>

Functions

addListener

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

- Defined in node_modules/@types/node/cluster.d.ts:201
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 Cluster
- Defined in node_modules/@types/node/cluster.d.ts:202
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:203
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:204
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:205
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:207
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:208
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:209
Parameters
- event: "setup"
- listener: function
  - - (settings: ClusterSettings): void
    - Parameters
      - settings: ClusterSettings
      Returns void
Returns Cluster

disconnect

disconnect(callback?: function): void

- Defined in node_modules/@types/node/cluster.d.ts:181
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

- Defined in node_modules/@types/node/cluster.d.ts:211
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
- Defined in node_modules/@types/node/cluster.d.ts:212
Parameters
- event: "disconnect"
- worker: Worker
Returns boolean
- Defined in node_modules/@types/node/cluster.d.ts:213
Parameters
- event: "exit"
- worker: Worker
- code: number
- signal: string
Returns boolean
- Defined in node_modules/@types/node/cluster.d.ts:214
Parameters
- event: "fork"
- worker: Worker
Returns boolean
- Defined in node_modules/@types/node/cluster.d.ts:215
Parameters
- event: "listening"
- worker: Worker
- address: Address
Returns boolean
- Defined in node_modules/@types/node/cluster.d.ts:216
Parameters
- event: "message"
- worker: Worker
- message: any
- handle: Socket | Server
Returns boolean
- Defined in node_modules/@types/node/cluster.d.ts:217
Parameters
- event: "online"
- worker: Worker
Returns boolean
- Defined in node_modules/@types/node/cluster.d.ts:218
Parameters
- event: "setup"
- settings: ClusterSettings
Returns boolean

eventNames

eventNames(): string[]

- Defined in node_modules/@types/node/cluster.d.ts:265
Returns string[]

fork

fork(env?: any): Worker

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

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/cluster.d.ts:241
Returns number

listenerCount

listenerCount(type: string): number

- Defined in node_modules/@types/node/cluster.d.ts:243
Parameters
- type: string
Returns number

listeners

listeners(event: string): Function[]

- Defined in node_modules/@types/node/cluster.d.ts:242
Parameters
- event: string
Returns Function[]

on

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

- Defined in node_modules/@types/node/cluster.d.ts:220
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:221
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:222
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:223
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:224
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:225
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:226
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:227
Parameters
- event: "setup"
- listener: function
  - - (settings: ClusterSettings): void
    - Parameters
      - settings: ClusterSettings
      Returns void
Returns Cluster

once

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

- Defined in node_modules/@types/node/cluster.d.ts:229
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:230
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:231
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:232
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:233
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:234
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:235
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:236
Parameters
- event: "setup"
- listener: function
  - - (settings: ClusterSettings): void
    - Parameters
      - settings: ClusterSettings
      Returns void
Returns Cluster

prependListener

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

- Defined in node_modules/@types/node/cluster.d.ts:245
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:246
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:247
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:248
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:249
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:251
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:252
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:253
Parameters
- event: "setup"
- listener: function
  - - (settings: ClusterSettings): void
    - Parameters
      - settings: ClusterSettings
      Returns void
Returns Cluster

prependOnceListener

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

- Defined in node_modules/@types/node/cluster.d.ts:255
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:256
Parameters
- event: "disconnect"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:257
Parameters
- event: "exit"
- listener: function
  - - (worker: Worker, code: number, signal: string): void
    - Parameters
      - worker: Worker
      - code: number
      - signal: string
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:258
Parameters
- event: "fork"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:259
Parameters
- event: "listening"
- listener: function
  - - (worker: Worker, address: Address): void
    - Parameters
      - worker: Worker
      - address: Address
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:261
Parameters
- event: "message"
- listener: function
  - - (worker: Worker, message: any, handle: Socket | Server): void
    - Parameters
      - worker: Worker
      - message: any
      - handle: Socket | Server
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:262
Parameters
- event: "online"
- listener: function
  - - (worker: Worker): void
    - Parameters
      - worker: Worker
      Returns void
Returns Cluster
- Defined in node_modules/@types/node/cluster.d.ts:263
Parameters
- event: "setup"
- listener: function
  - - (settings: ClusterSettings): void
    - Parameters
      - settings: ClusterSettings
      Returns void
Returns Cluster

removeAllListeners

removeAllListeners(event?: string): Cluster

- Defined in node_modules/@types/node/cluster.d.ts:239
Parameters
- Optional event: string
Returns Cluster

removeListener

removeListener(event: string, listener: function): Cluster

- Defined in node_modules/@types/node/cluster.d.ts:238
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Cluster

setMaxListeners

setMaxListeners(n: number): Cluster

- Defined in node_modules/@types/node/cluster.d.ts:240
Parameters
- n: number
Returns Cluster

setupMaster

setupMaster(settings?: ClusterSettings): void

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

Index

Classes

Interfaces

Variables

Functions

Variables

Const SCHED_NONE

Const SCHED_RR

Const isMaster

Const isWorker

Let schedulingPolicy

Const settings

Const worker

Const workers

Functions

addListener

Parameters

event: string

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns Cluster

Parameters

event: "disconnect"

listener: function

Parameters

worker: Worker

Returns void

Returns Cluster

Parameters

event: "exit"

listener: function

Parameters

worker: Worker

code: number

signal: string

Returns void

Returns Cluster

Parameters

event: "fork"

listener: function

Parameters

worker: Worker

Returns void

Returns Cluster

Parameters

event: "listening"

listener: function

Parameters

worker: Worker

address: Address

Returns void

Returns Cluster

Parameters

event: "message"

listener: function

Parameters

worker: Worker

message: any

handle: Socket | Server

Returns void

Returns Cluster

Parameters

event: "online"

listener: function

Parameters

worker: Worker

Returns void

Returns Cluster

Parameters

event: "setup"

listener: function

Parameters

settings: ClusterSettings

Returns void

Returns Cluster

disconnect

Parameters

Optional callback: function