From 66fc6ae43f2e7a308cdba9d5038d07cf49b9cda4 Mon Sep 17 00:00:00 2001
From: Documentation Bot
+
@@ -202,12 +202,12 @@
Returns AbstractPool<Worker, Data, Response>
Properties
-Optional
emitterProtected
Optional
Readonly
maxpoolifier:<PoolType>-<Wo
Protected
Readonly
numberpoolifier:<PoolType>-<Wo
@@ -256,7 +256,7 @@ The async tracking tooling identifier is Protected
Readonly
optspoolifier:<PoolType>-<Wo
@@ -269,7 +269,7 @@ The async tracking tooling identifier is Protected
promisepoolifier:<PoolType>-<Wo
Private
Readonly
startpoolifier:<PoolType>-<Wo
Private
startedpoolifier:<PoolType>-<Wo
Private
startingpoolifier:<PoolType>-<Wo
@@ -305,7 +305,7 @@ The async tracking tooling identifier is Private
Readonly
taskpoolifier:<PoolType>-<Wo
@@ -313,7 +313,7 @@ The async tracking tooling identifier is Protected
workerpoolifier:<PoolType>-<Wo
@@ -322,7 +322,7 @@ The async tracking tooling identifier is Readonly
Internal
workerpoolifier:<PoolType>-<Wo
Accessors
poolifier:<PoolType>-<Wo
Returns boolean
Protected
full
@@ -348,7 +348,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Returns boolean
info
@@ -360,7 +360,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
max
@@ -371,7 +371,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Returns number
Protected
min
@@ -382,7 +382,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Returns number
Private
ready
@@ -393,7 +393,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Returns boolean
Protected
Abstract
type
@@ -405,7 +405,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Returns "fixed" | "dynamic"
Private
utilization
@@ -417,7 +417,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
Abstract
worker
@@ -428,7 +428,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Returns "thread" | "cluster"
Methods
Private
addhttps://nodejs.org/api/errors.html#class-error If the added worker node is not found.
Protected
afterProtected
afterProtected
beforePrivate
buildPrivate
checkPrivate
checkPrivate
checkPrivate
checkhttps://nodejs.org/api/errors.html#class-error If the worker id is invalid.
Private
checkPrivate
checkPrivate
checkPrivate
chooseProtected
createProtected
createProtected
Abstract
createPrivate
deletePrivate
dequeueProtected
Abstract
deregisterProtected
Abstract
destroyPrivate
enqueuePrivate
executeProtected
flushPrivate
flushProtected
getPrivate
getPrivate
getPrivate
handlePrivate
handlePrivate
hasPrivate
initializeProtected
internalProtected
Abstract
isPrivate
redistributeProtected
Abstract
registerProtected
Abstract
registerPrivate
removeProtected
sendProtected
Abstract
sendPrivate
sendPrivate
sendPrivate
sendProtected
Abstract
sendPrivate
setPrivate
setPrivate
setProtected
setupPrivate
shallPrivate
shallPrivate
shallPrivate
taskPrivate
tasksPrivate
tasksPrivate
unsetPrivate
unsetPrivate
updatePrivate
updatePrivate
updatePrivate
updatePrivate
updateProtected
workerProtected
Abstract
idProtected
Readonly
isProtected
lastPrivate
Readonly
mainProtected
optsProtected
statisticsProtected
taskPrivate
beginOptional
name: stringPrivate
checkPrivate
checkhttps://nodejs.org/api/errors.html#class-error If the message worker id is not set or does not match the worker id.
Private
checkPrivate
checkPrivate
checkPrivate
endProtected
gethttps://nodejs.org/api/errors.html#class-error If the main worker is not set.
Protected
handleProtected
handleProtected
Abstract
handleProtected
handleProtected
messageProtected
runProtected
runProtected
runProtected
sendProtected
Abstract
sendPrivate
startPrivate
stopPrivate
updateStatic
bindStatic
Readonly
[species]Protected
Readonly
isProtected
lastProtected
optsProtected
statisticsProtected
taskProtected
getProtected
handleProtected
handleProtected
handleProtected
handleProtected
messageProtected
runProtected
runProtected
runProtected
sendProtected
sendStatic
bindPrivate
Optional
headPrivate
Optional
tailhttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
Private
incrementOptional
emitterEvent emitter integrated with async resource on which events can be listened to.
The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool
.
Events that can currently be listened to:
@@ -178,7 +178,7 @@ The async tracking tooling identifier ispoolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:73
Protected
Readonly
file Path
file Path: string
@@ -187,7 +187,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:128
Protected
Readonly
max
max: number
@@ -196,7 +196,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/cluster/dynamic.ts:30
Protected
Readonly
number Of Workers
number Of Workers: number
@@ -205,7 +205,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -214,7 +214,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/cluster/fixed.ts:47
Protected
promise Response Map
@@ -228,7 +228,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:82
Protected
worker Choice Strategy Context
@@ -237,7 +237,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:88
Readonly
Internal
worker Nodes
@@ -246,7 +246,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:70
Accessors
@@ -261,7 +261,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/cluster/dynamic.ts:44
Protected
full
@@ -274,7 +274,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:651
info
@@ -286,7 +286,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:271
Protected
max Size
@@ -298,7 +298,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:484
Protected
min Size
@@ -310,7 +310,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:477
Private
ready
@@ -322,7 +322,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:429
Protected
type
@@ -335,7 +335,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/cluster/dynamic.ts:39
Private
utilization
@@ -348,7 +348,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:446
Protected
worker
@@ -360,7 +360,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/cluster/fixed.ts:134
Methods
@@ -393,7 +393,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/abstract-pool.ts:796
Protected
after Task Execution Hook
@@ -419,7 +419,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1033
Protected
after Worker Node Setup
@@ -440,7 +440,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1344
Protected
before Task Execution Hook
@@ -466,7 +466,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1003
Protected
create And Setup Dynamic Worker Node
@@ -479,7 +479,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1250
Protected
create And Setup Worker Node
@@ -492,7 +492,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1206
Protected
create Worker
@@ -505,7 +505,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:124
Protected
deregister Worker Message Listener
@@ -546,7 +546,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:116
destroy
@@ -558,7 +558,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:940
Protected
destroy Worker Node
@@ -578,7 +578,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:63
enable Tasks Queue
@@ -603,7 +603,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:565
execute
@@ -634,7 +634,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:870
Protected
flush Tasks Queue
@@ -648,7 +648,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1667
Protected
get Worker Info
@@ -669,7 +669,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1583
has Task Function
@@ -690,7 +690,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:783
has Worker Node Back Pressure
@@ -711,7 +711,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1625
Protected
internal Busy
@@ -724,7 +724,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:667
Protected
is Main
@@ -736,7 +736,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:58
list Task Function Names
@@ -749,7 +749,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:835
Protected
register Once Worker Message Listener
@@ -790,7 +790,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:108
Protected
register Worker Message Listener
@@ -831,7 +831,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:100
remove Task Function
@@ -852,7 +852,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:819
Protected
send Kill Message To Worker
@@ -866,7 +866,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:951
Protected
send Startup Message To Worker
@@ -886,7 +886,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:93
Protected
send To Worker
@@ -911,7 +911,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:82
set Default Task Function
@@ -932,7 +932,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:848
set Tasks Queue Options
@@ -952,7 +952,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:579
set Worker Choice Strategy
@@ -977,7 +977,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:532
set Worker Choice Strategy Options
@@ -997,7 +997,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:551
Protected
setup Hook
@@ -1010,7 +1010,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:53
start
@@ -1022,7 +1022,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:924
Protected
worker Listener
@@ -1050,7 +1050,7 @@ Can be overridden.
Optional
emitterEvent emitter integrated with async resource on which events can be listened to.
The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool
.
Events that can currently be listened to:
@@ -178,7 +178,7 @@ The async tracking tooling identifier ispoolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:73
Protected
Readonly
file Path
file Path: string
@@ -187,7 +187,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:128
Protected
Readonly
max
max: number
@@ -196,7 +196,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/thread/dynamic.ts:30
Protected
Readonly
number Of Workers
number Of Workers: number
@@ -205,7 +205,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -214,7 +214,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/thread/fixed.ts:49
Protected
promise Response Map
@@ -228,7 +228,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:82
Protected
worker Choice Strategy Context
@@ -237,7 +237,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:88
Readonly
Internal
worker Nodes
@@ -246,7 +246,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:70
Accessors
@@ -261,7 +261,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/thread/dynamic.ts:44
Protected
full
@@ -274,7 +274,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:651
info
@@ -286,7 +286,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:271
Protected
max Size
@@ -298,7 +298,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:484
Protected
min Size
@@ -310,7 +310,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:477
Private
ready
@@ -322,7 +322,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:429
Protected
type
@@ -335,7 +335,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/thread/dynamic.ts:39
Private
utilization
@@ -348,7 +348,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:446
Protected
worker
@@ -360,7 +360,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/thread/fixed.ts:149
Methods
@@ -393,7 +393,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/abstract-pool.ts:796
Protected
after Task Execution Hook
@@ -419,7 +419,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1033
Protected
after Worker Node Setup
@@ -440,7 +440,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1344
Protected
before Task Execution Hook
@@ -466,7 +466,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1003
Protected
create And Setup Dynamic Worker Node
@@ -479,7 +479,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1250
Protected
create And Setup Worker Node
@@ -492,7 +492,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1206
Protected
create Worker
@@ -505,7 +505,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:136
Protected
deregister Worker Message Listener
@@ -546,7 +546,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:126
destroy
@@ -558,7 +558,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:940
Protected
destroy Worker Node
@@ -578,7 +578,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:60
enable Tasks Queue
@@ -603,7 +603,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:565
execute
@@ -634,7 +634,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:870
Protected
flush Tasks Queue
@@ -648,7 +648,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1667
Protected
get Worker Info
@@ -669,7 +669,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1583
has Task Function
@@ -690,7 +690,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:783
has Worker Node Back Pressure
@@ -711,7 +711,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1625
Protected
internal Busy
@@ -724,7 +724,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:667
Protected
is Main
@@ -736,7 +736,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:55
list Task Function Names
@@ -749,7 +749,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:835
Protected
register Once Worker Message Listener
@@ -790,7 +790,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:116
Protected
register Worker Message Listener
@@ -831,7 +831,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:106
remove Task Function
@@ -852,7 +852,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:819
Protected
send Kill Message To Worker
@@ -866,7 +866,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:951
Protected
send Startup Message To Worker
@@ -886,7 +886,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:91
Protected
send To Worker
@@ -916,7 +916,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:77
set Default Task Function
@@ -937,7 +937,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:848
set Tasks Queue Options
@@ -957,7 +957,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:579
set Worker Choice Strategy
@@ -982,7 +982,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:532
set Worker Choice Strategy Options
@@ -1002,7 +1002,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:551
Protected
setup Hook
@@ -1015,7 +1015,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:987
start
@@ -1027,7 +1027,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:924
Protected
worker Listener
@@ -1055,7 +1055,7 @@ Can be overridden.
Optional
emitterEvent emitter integrated with async resource on which events can be listened to.
The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool
.
Events that can currently be listened to:
@@ -173,7 +173,7 @@ The async tracking tooling identifier ispoolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:73
Protected
Readonly
file Path
file Path: string
@@ -182,7 +182,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:128
Protected
Optional
Readonly
max
max?: number
@@ -191,7 +191,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:97
Protected
Readonly
number Of Workers
number Of Workers: number
@@ -200,7 +200,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -209,7 +209,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/cluster/fixed.ts:47
Protected
promise Response Map
@@ -223,7 +223,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:82
Protected
worker Choice Strategy Context
@@ -232,7 +232,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:88
Readonly
Internal
worker Nodes
@@ -241,7 +241,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:70
Accessors
@@ -256,7 +256,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/cluster/fixed.ts:139
Protected
full
@@ -269,7 +269,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:651
info
@@ -281,7 +281,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:271
Protected
max Size
@@ -293,7 +293,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:484
Protected
min Size
@@ -305,7 +305,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:477
Private
ready
@@ -317,7 +317,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:429
Protected
type
@@ -330,7 +330,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/cluster/fixed.ts:129
Private
utilization
@@ -343,7 +343,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:446
Protected
worker
@@ -355,7 +355,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/cluster/fixed.ts:134
Methods
@@ -388,7 +388,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/abstract-pool.ts:796
Protected
after Task Execution Hook
@@ -414,7 +414,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1033
Protected
after Worker Node Setup
@@ -435,7 +435,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1344
Protected
before Task Execution Hook
@@ -461,7 +461,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1003
Protected
create And Setup Dynamic Worker Node
@@ -474,7 +474,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1250
Protected
create And Setup Worker Node
@@ -487,7 +487,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1206
Protected
create Worker
@@ -500,7 +500,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:124
Protected
deregister Worker Message Listener
@@ -541,7 +541,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:116
destroy
@@ -553,7 +553,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:940
Protected
destroy Worker Node
@@ -573,7 +573,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:63
enable Tasks Queue
@@ -598,7 +598,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:565
execute
@@ -629,7 +629,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:870
Protected
flush Tasks Queue
@@ -643,7 +643,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1667
Protected
get Worker Info
@@ -664,7 +664,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1583
has Task Function
@@ -685,7 +685,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:783
has Worker Node Back Pressure
@@ -706,7 +706,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1625
Protected
internal Busy
@@ -719,7 +719,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:667
Protected
is Main
@@ -731,7 +731,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:58
list Task Function Names
@@ -744,7 +744,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:835
Protected
register Once Worker Message Listener
@@ -785,7 +785,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:108
Protected
register Worker Message Listener
@@ -826,7 +826,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:100
remove Task Function
@@ -847,7 +847,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:819
Protected
send Kill Message To Worker
@@ -861,7 +861,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:951
Protected
send Startup Message To Worker
@@ -881,7 +881,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:93
Protected
send To Worker
@@ -906,7 +906,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:82
set Default Task Function
@@ -927,7 +927,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:848
set Tasks Queue Options
@@ -947,7 +947,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:579
set Worker Choice Strategy
@@ -972,7 +972,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:532
set Worker Choice Strategy Options
@@ -992,7 +992,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:551
Protected
setup Hook
@@ -1005,7 +1005,7 @@ Can be overridden.
+Defined in src/pools/cluster/fixed.ts:53
start
@@ -1017,7 +1017,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:924
Protected
worker Listener
@@ -1045,7 +1045,7 @@ Can be overridden.
Optional
emitterEvent emitter integrated with async resource on which events can be listened to.
The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool
.
Events that can currently be listened to:
@@ -173,7 +173,7 @@ The async tracking tooling identifier ispoolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:73
Protected
Readonly
file Path
file Path: string
@@ -182,7 +182,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:128
Protected
Optional
Readonly
max
max?: number
@@ -191,7 +191,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:97
Protected
Readonly
number Of Workers
number Of Workers: number
@@ -200,7 +200,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -209,7 +209,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/thread/fixed.ts:49
Protected
promise Response Map
@@ -223,7 +223,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:82
Protected
worker Choice Strategy Context
@@ -232,7 +232,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:88
Readonly
Internal
worker Nodes
@@ -241,7 +241,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:70
Accessors
@@ -256,7 +256,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/thread/fixed.ts:154
Protected
full
@@ -269,7 +269,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:651
info
@@ -281,7 +281,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:271
Protected
max Size
@@ -293,7 +293,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:484
Protected
min Size
@@ -305,7 +305,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:477
Private
ready
@@ -317,7 +317,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:429
Protected
type
@@ -330,7 +330,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/thread/fixed.ts:144
Private
utilization
@@ -343,7 +343,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:446
Protected
worker
@@ -355,7 +355,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/thread/fixed.ts:149
Methods
@@ -388,7 +388,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/abstract-pool.ts:796
Protected
after Task Execution Hook
@@ -414,7 +414,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1033
Protected
after Worker Node Setup
@@ -435,7 +435,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1344
Protected
before Task Execution Hook
@@ -461,7 +461,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1003
Protected
create And Setup Dynamic Worker Node
@@ -474,7 +474,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1250
Protected
create And Setup Worker Node
@@ -487,7 +487,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1206
Protected
create Worker
@@ -500,7 +500,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:136
Protected
deregister Worker Message Listener
@@ -541,7 +541,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:126
destroy
@@ -553,7 +553,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:940
Protected
destroy Worker Node
@@ -573,7 +573,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:60
enable Tasks Queue
@@ -598,7 +598,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:565
execute
@@ -629,7 +629,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:870
Protected
flush Tasks Queue
@@ -643,7 +643,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1667
Protected
get Worker Info
@@ -664,7 +664,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1583
has Task Function
@@ -685,7 +685,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:783
has Worker Node Back Pressure
@@ -706,7 +706,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1625
Protected
internal Busy
@@ -719,7 +719,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:667
Protected
is Main
@@ -731,7 +731,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:55
list Task Function Names
@@ -744,7 +744,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:835
Protected
register Once Worker Message Listener
@@ -785,7 +785,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:116
Protected
register Worker Message Listener
@@ -826,7 +826,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:106
remove Task Function
@@ -847,7 +847,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:819
Protected
send Kill Message To Worker
@@ -861,7 +861,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:951
Protected
send Startup Message To Worker
@@ -881,7 +881,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:91
Protected
send To Worker
@@ -911,7 +911,7 @@ Can be overridden.
+Defined in src/pools/thread/fixed.ts:77
set Default Task Function
@@ -932,7 +932,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:848
set Tasks Queue Options
@@ -952,7 +952,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:579
set Worker Choice Strategy
@@ -977,7 +977,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:532
set Worker Choice Strategy Options
@@ -997,7 +997,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:551
Protected
setup Hook
@@ -1010,7 +1010,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:987
start
@@ -1022,7 +1022,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:924
Protected
worker Listener
@@ -1050,7 +1050,7 @@ Can be overridden.
Optional
nextOptional
prevProtected
Readonly
isProtected
lastProtected
optsPrivate
portProtected
statisticsProtected
taskProtected
getProtected
handleProtected
handleProtected
handleProtected
handleProtected
messageProtected
runProtected
runProtected
runProtected
sendProtected
sendStatic
bindPrivate
retriesPrivate
Readonly
workerPrivate
workerhttps://nodejs.org/api/errors.html#class-error If after configured retries the worker node key is null or undefined .
Optional
enableOptional
envhttps://nodejs.org/api/cluster.html#cluster_cluster_fork_env
Optional
errorOptional
exitOptional
messageOptional
onlineOptional
restartOptional
settingshttps://nodejs.org/api/cluster.html#cluster_cluster_settings
Optional
startOptional
tasksOptional
workerOptional
workerReadonly
idleOptional
utilizationhttps://nodejs.org/api/errors.html#class-typeerror If the fn
parameter is not a function.
Readonly
destroyOptional
Readonly
emitterEvent emitter integrated with async resource on which events can be listened to.
The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool
.
Events that can currently be listened to:
@@ -142,7 +142,7 @@ The async tracking tooling identifier ispoolifier:<PoolType>-<Wo
Readonly
enablepoolifier:<PoolType>-<Wo
Returns void
Readonly
executepoolifier:<PoolType>-<Wo
Readonly
haspoolifier:<PoolType>-<Wo
Readonly
haspoolifier:<PoolType>-<Wo
Readonly
infopoolifier:<PoolType>-<Wo
Readonly
listpoolifier:<PoolType>-<Wo
Readonly
removepoolifier:<PoolType>-<Wo
Readonly
setpoolifier:<PoolType>-<Wo
Readonly
setpoolifier:<PoolType>-<Wo
Returns void
Readonly
setpoolifier:<PoolType>-<Wo
Returns void
Readonly
setpoolifier:<PoolType>-<Wo
Returns void
Readonly
startpoolifier:<PoolType>-<Wo
Returns void
Readonly
Internal
workerpoolifier:<PoolType>-<Wo
Readonly
onThe event handler.
Readonly
onceOptional
Readonly
threadundefined
is returned, the caller retry.
Readonly
removeundefined
is returned, the caller retry.
Readonly
resetundefined
is returned, the caller retry.
Readonly
setundefined
is returned, the caller retry.
Readonly
strategyundefined
is returned, the caller retry.
Readonly
taskundefined
is returned, the caller retry.
Readonly
updateReadonly
closeReadonly
deleteReadonly
dequeueReadonly
enqueueReadonly
getReadonly
hasReadonly
infoOptional
Readonly
messageOptional
onOptional
onReadonly
popReadonly
resetOptional
strategyReadonly
tasksReadonly
unshiftReadonly
usageReadonly
workerOptional
averageReadonly
historyOptional
maximumOptional
medianOptional
minimumOptional
Readonly
dataOptional
Readonly
killOptional
Readonly
nameOptional
Readonly
portOptional
Readonly
readyOptional
Readonly
statisticsOptional
Readonly
taskOptional
Readonly
taskOptional
Readonly
taskOptional
Readonly
taskOptional
Readonly
taskOptional
Readonly
taskOptional
Readonly
taskOptional
Readonly
timestampOptional
Readonly
transferOptional
Readonly
workerOptional
Readonly
workerReadonly
busyReadonly
executedReadonly
executingReadonly
failedReadonly
idleOptional
Readonly
maxReadonly
maxReadonly
minOptional
Readonly
queuedReadonly
readyOptional
Readonly
runReadonly
minimum: numberReadonly
startedOptional
Readonly
stolenReadonly
strategyReadonly
typeOptional
Readonly
utilizationReadonly
versionOptional
Readonly
waitReadonly
minimum: numberReadonly
workerReadonly
workerOptional
enableOptional
error() => {}
Optional
exit() => {}
Optional
message() => {}
Optional
online() => {}
Optional
restartOptional
startOptional
tasksOptional
workerOptional
workerReadonly
resolveReadonly
workerReadonly
dynamicOptional
Readonly
nameOptional
Readonly
taskOptional
Readonly
timestampOptional
Readonly
transferOptional
Readonly
workerReadonly
nameOptional
Readonly
runReadonly
timestampOptional
Readonly
maxReadonly
queuedReadonly
runReadonly
waitOptional
Readonly
sizeOptional
Readonly
taskWhether to enable task stealing.
+Whether to enable task stealing on empty queue.
true
Optional
Readonly
tasksWhether to enable tasks stealing on back pressure.
+Whether to enable tasks stealing under back pressure.
true
Optional
enableOptional
errorOptional
exitOptional
messageOptional
onlineOptional
restartOptional
startOptional
tasksOptional
workerOptional
workerOptional
workerhttps://nodejs.org/api/worker_threads.html#new-workerfilename-options
Optional
Readonly
measurementOptional
Readonly
retriesOptional
Readonly
runOptional
Readonly
waitOptional
Readonly
weightsReadonly
messageReadonly
nameReadonly
idOptional
taskReadonly
typeThis option will be removed in the next major version.
Optional
killOptional
kill() => {}
Optional
maxReadonly
runReadonly
runReadonly
tasksReadonly
waitReadonly
waitReadonly
taskReadonly
thread: "thread"
Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is
poolifier:<PoolType>-<WorkerType>-pool
.Events that can currently be listened to:
@@ -224,7 +224,7 @@ The async tracking tooling identifier ispoolifier:<PoolType>-<Wo +Defined in src/pools/abstract-pool.ts:73
Path
file Path: string
@@ -232,7 +232,7 @@ The async tracking tooling identifier is
Protected
Readonly
filepoolifier:<PoolType>-<Wo