Search
Preparing search index...
The search index is not available
⚡️Boltwall⚡️
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"node_modules/@types/node/cluster.d"
"cluster"
Cluster
Interface Cluster
Hierarchy
EventEmitter
Cluster
Index
Properties
Worker
is
Master
is
Worker
settings
worker
workers
default
Max
Listeners
Methods
add
Listener
disconnect
emit
event
Names
fork
get
Max
Listeners
listener
Count
listeners
off
on
once
prepend
Listener
prepend
Once
Listener
raw
Listeners
remove
All
Listeners
remove
Listener
set
Max
Listeners
setup
Master
listener
Count
Properties
Worker
Worker
:
Worker
is
Master
is
Master
:
boolean
is
Worker
is
Worker
:
boolean
settings
settings
:
ClusterSettings
Optional
worker
worker
:
Worker
Optional
workers
workers
:
undefined
|
object
Static
default
Max
Listeners
default
Max
Listeners
:
number
Methods
add
Listener
add
Listener
(
event
:
string
, listener
:
function
)
:
this
add
Listener
(
event
:
"disconnect"
, listener
:
function
)
:
this
add
Listener
(
event
:
"exit"
, listener
:
function
)
:
this
add
Listener
(
event
:
"fork"
, listener
:
function
)
:
this
add
Listener
(
event
:
"listening"
, listener
:
function
)
:
this
add
Listener
(
event
:
"message"
, listener
:
function
)
:
this
add
Listener
(
event
:
"online"
, listener
:
function
)
:
this
add
Listener
(
event
:
"setup"
, listener
:
function
)
:
this
events.EventEmitter
disconnect
exit
fork
listening
message
online
setup
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"disconnect"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
this
Parameters
event:
"exit"
listener:
function
(
worker
:
Worker
, code
:
number
, signal
:
string
)
:
void
Parameters
worker:
Worker
code:
number
signal:
string
Returns
void
Returns
this
Parameters
event:
"fork"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
this
Parameters
event:
"listening"
listener:
function
(
worker
:
Worker
, address
:
Address
)
:
void
Parameters
worker:
Worker
address:
Address
Returns
void
Returns
this
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
Parameters
event:
"online"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
this
Parameters
event:
"setup"
listener:
function
(
settings
:
ClusterSettings
)
:
void
Parameters
settings:
ClusterSettings
Returns
void
Returns
this
disconnect
disconnect
(
callback
?:
undefined
|
function
)
:
void
Parameters
Optional
callback:
undefined
|
function
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
Parameters
event:
string
|
symbol
Rest
...
args:
any
[]
Returns
boolean
Parameters
event:
"disconnect"
worker:
Worker
Returns
boolean
Parameters
event:
"exit"
worker:
Worker
code:
number
signal:
string
Returns
boolean
Parameters
event:
"fork"
worker:
Worker
Returns
boolean
Parameters
event:
"listening"
worker:
Worker
address:
Address
Returns
boolean
Parameters
event:
"message"
worker:
Worker
message:
any
handle:
Socket
|
Server
Returns
boolean
Parameters
event:
"online"
worker:
Worker
Returns
boolean
Parameters
event:
"setup"
settings:
ClusterSettings
Returns
boolean
event
Names
event
Names
(
)
:
Array
<
string
|
symbol
>
Returns
Array
<
string
|
symbol
>
fork
fork
(
env
?:
any
)
:
Worker
Parameters
Optional
env:
any
Returns
Worker
get
Max
Listeners
get
Max
Listeners
(
)
:
number
Returns
number
listener
Count
listener
Count
(
type
:
string
|
symbol
)
:
number
Parameters
type:
string
|
symbol
Returns
number
listeners
listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
off
off
(
event
:
string
|
symbol
, listener
:
function
)
:
this
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
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"disconnect"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
this
Parameters
event:
"exit"
listener:
function
(
worker
:
Worker
, code
:
number
, signal
:
string
)
:
void
Parameters
worker:
Worker
code:
number
signal:
string
Returns
void
Returns
this
Parameters
event:
"fork"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
this
Parameters
event:
"listening"
listener:
function
(
worker
:
Worker
, address
:
Address
)
:
void
Parameters
worker:
Worker
address:
Address
Returns
void
Returns
this
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
Parameters
event:
"online"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
this
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
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"disconnect"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
this
Parameters
event:
"exit"
listener:
function
(
worker
:
Worker
, code
:
number
, signal
:
string
)
:
void
Parameters
worker:
Worker
code:
number
signal:
string
Returns
void
Returns
this
Parameters
event:
"fork"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
this
Parameters
event:
"listening"
listener:
function
(
worker
:
Worker
, address
:
Address
)
:
void
Parameters
worker:
Worker
address:
Address
Returns
void
Returns
this
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
Parameters
event:
"online"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
this
Parameters
event:
"setup"
listener:
function
(
settings
:
ClusterSettings
)
:
void
Parameters
settings:
ClusterSettings
Returns
void
Returns
this
prepend
Listener
prepend
Listener
(
event
:
string
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"disconnect"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"exit"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"fork"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"listening"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"message"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"online"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"setup"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"disconnect"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
this
Parameters
event:
"exit"
listener:
function
(
worker
:
Worker
, code
:
number
, signal
:
string
)
:
void
Parameters
worker:
Worker
code:
number
signal:
string
Returns
void
Returns
this
Parameters
event:
"fork"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
this
Parameters
event:
"listening"
listener:
function
(
worker
:
Worker
, address
:
Address
)
:
void
Parameters
worker:
Worker
address:
Address
Returns
void
Returns
this
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
Parameters
event:
"online"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
this
Parameters
event:
"setup"
listener:
function
(
settings
:
ClusterSettings
)
:
void
Parameters
settings:
ClusterSettings
Returns
void
Returns
this
prepend
Once
Listener
prepend
Once
Listener
(
event
:
string
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"disconnect"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"exit"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"fork"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"listening"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"message"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"online"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"setup"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"disconnect"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
this
Parameters
event:
"exit"
listener:
function
(
worker
:
Worker
, code
:
number
, signal
:
string
)
:
void
Parameters
worker:
Worker
code:
number
signal:
string
Returns
void
Returns
this
Parameters
event:
"fork"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
this
Parameters
event:
"listening"
listener:
function
(
worker
:
Worker
, address
:
Address
)
:
void
Parameters
worker:
Worker
address:
Address
Returns
void
Returns
this
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
Parameters
event:
"online"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
this
Parameters
event:
"setup"
listener:
function
(
settings
:
ClusterSettings
)
:
void
Parameters
settings:
ClusterSettings
Returns
void
Returns
this
raw
Listeners
raw
Listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
remove
All
Listeners
remove
All
Listeners
(
event
?:
string
|
symbol
)
:
this
Parameters
Optional
event:
string
|
symbol
Returns
this
remove
Listener
remove
Listener
(
event
:
string
|
symbol
, listener
:
function
)
:
this
Parameters
event:
string
|
symbol
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
:
this
Parameters
n:
number
Returns
this
setup
Master
setup
Master
(
settings
?:
ClusterSettings
)
:
void
Parameters
Optional
settings:
ClusterSettings
Returns
void
Static
listener
Count
listener
Count
(
emitter
:
EventEmitter
, event
:
string
|
symbol
)
:
number
deprecated
since v4.0.0
Parameters
emitter:
EventEmitter
event:
string
|
symbol
Returns
number
Globals
"node_
modules/@types/node/cluster.d"
"cluster"
Worker
Address
Cluster
Worker
is
Master
is
Worker
settings
worker
workers
default
Max
Listeners
add
Listener
disconnect
emit
event
Names
fork
get
Max
Listeners
listener
Count
listeners
off
on
once
prepend
Listener
prepend
Once
Listener
raw
Listeners
remove
All
Listeners
remove
Listener
set
Max
Listeners
setup
Master
listener
Count
Cluster
Settings
is
Master
is
Worker
settings
worker
workers
add
Listener
disconnect
emit
event
Names
fork
get
Max
Listeners
listener
Count
listeners
on
once
prepend
Listener
prepend
Once
Listener
remove
All
Listeners
remove
Listener
set
Max
Listeners
setup
Master
Generated using
TypeDoc
events.EventEmitter