From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Date: Wed, 6 Sep 2023 21:20:06 +0000 (+0000)
Subject: docs: generate documentation
X-Git-Tag: v2.6.43~23
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=665702eef3ad8153279b344e0276687f7f50c10f;p=poolifier.git
docs: generate documentation
---
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 0ca50a44..dec90f6f 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-AbstractPool | poolifier - v2.6.41
+AbstractPool | poolifier - v2.6.42
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:59
@@ -191,7 +191,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:115
Protected Readonly filePath
filePath: string
@@ -220,7 +220,7 @@
+
Defined in src/pools/abstract-pool.ts:117
Protected Optional Readonly max
max?: number
@@ -228,7 +228,7 @@
+Defined in src/pools/abstract-pool.ts:93
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -236,7 +236,7 @@
+Defined in src/pools/abstract-pool.ts:116
Protected Readonly opts
@@ -244,7 +244,7 @@
+Defined in src/pools/abstract-pool.ts:118
Protected promiseResponseMap
@@ -257,7 +257,7 @@
+Defined in src/pools/abstract-pool.ts:78
Private Readonly startTimestamp
startTimestamp: number
@@ -265,7 +265,7 @@
+Defined in src/pools/abstract-pool.ts:106
Private started
started: boolean
@@ -273,7 +273,7 @@
+Defined in src/pools/abstract-pool.ts:102
Private Readonly starting
starting: boolean
@@ -281,7 +281,7 @@
+Defined in src/pools/abstract-pool.ts:98
Protected workerChoiceStrategyContext
@@ -289,7 +289,7 @@
+Defined in src/pools/abstract-pool.ts:84
Readonly Internal workerNodes
@@ -298,7 +298,7 @@
+Defined in src/pools/abstract-pool.ts:65
Protected full
@@ -324,7 +324,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:689
+Defined in src/pools/abstract-pool.ts:350
Protected maxSize
@@ -347,7 +347,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:562
Protected minSize
@@ -358,7 +358,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:555
Private ready
@@ -369,7 +369,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:507
Protected Abstract type
@@ -381,7 +381,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:545
+Defined in src/pools/abstract-pool.ts:524
Protected Abstract worker
@@ -404,7 +404,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:550
Protected afterTaskExecutionHook
@@ -453,7 +453,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:888
Protected afterWorkerNodeSetup
@@ -473,7 +473,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1162
Protected beforeTaskExecutionHook
@@ -498,7 +498,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:858
Private buildTasksQueueOptions
@@ -511,7 +511,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:672
Private checkAndEmitDynamicWorkerCreationEvents
@@ -519,7 +519,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1393
Private checkAndEmitTaskExecutionEvents
@@ -527,7 +527,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1381
Private checkAndEmitTaskQueuingEvents
@@ -535,7 +535,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1387
Protected checkDynamicPoolSize
@@ -550,7 +550,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:187
Private checkFilePath
@@ -563,7 +563,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:156
Private checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:572
Private checkNumberOfWorkers
@@ -597,7 +597,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:169
Private checkPoolOptions
@@ -610,7 +610,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:213
Private checkValidTasksQueueOptions
@@ -623,7 +623,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:295
Private checkValidWorkerChoiceStrategy
@@ -636,7 +636,7 @@ Can be overridden.
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Returns void
+Defined in src/pools/abstract-pool.ts:241
Private checkValidWorkerChoiceStrategyOptions
@@ -649,7 +649,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:251
Private chooseWorkerNode
@@ -662,7 +662,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1015
Protected createAndSetupDynamicWorkerNode
@@ -674,7 +674,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1105
Protected createAndSetupWorkerNode
@@ -686,7 +686,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1061
Protected Abstract createWorker
@@ -698,7 +698,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1054
Private dequeueTask
@@ -711,7 +711,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1483
+Defined in src/pools/abstract-pool.ts:803
Protected Abstract destroyWorkerNode
@@ -742,7 +742,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:834
+Defined in src/pools/abstract-pool.ts:643
Private enqueueTask
@@ -782,7 +782,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1477
+Defined in src/pools/abstract-pool.ts:747
Private executeTask
@@ -837,7 +837,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1471
Protected flushTasksQueue
@@ -850,7 +850,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1491
Private flushTasksQueues
@@ -858,7 +858,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1501
Protected getWorkerInfo
@@ -878,7 +878,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1407
Private getWorkerNodeKeyByWorker
@@ -898,7 +898,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:591
Private getWorkerNodeKeyByWorkerId
@@ -918,7 +918,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:603
Private handleTaskExecutionResponse
@@ -931,7 +931,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1353
Private handleWorkerReadyResponse
@@ -944,7 +944,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1339
Private hasBackPressure
@@ -952,7 +952,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1456
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1449
Protected internalBusy
@@ -985,7 +985,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:705
Protected Abstract isMain
@@ -996,7 +996,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:849
+Defined in src/pools/abstract-pool.ts:726
Private redistributeQueuedTasks
@@ -1022,7 +1022,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1202
Protected Abstract registerWorkerMessageListener
@@ -1062,7 +1062,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1149
Private removeWorkerNode
@@ -1081,7 +1081,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1440
Protected sendKillMessageToWorker
@@ -1096,7 +1096,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:813
Protected Abstract sendStartupMessageToWorker
@@ -1115,7 +1115,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1182
Private sendStatisticsMessageToWorker
@@ -1134,7 +1134,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1189
Protected Abstract sendToWorker
@@ -1163,7 +1163,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1043
+Defined in src/pools/abstract-pool.ts:655
Private setTasksQueueSize
@@ -1196,7 +1196,7 @@ Can be overridden.
size: number
Returns void
+Defined in src/pools/abstract-pool.ts:666
+Defined in src/pools/abstract-pool.ts:610
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:629
Protected setupHook
@@ -1253,7 +1253,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:842
Private shallCreateDynamicWorker
@@ -1265,7 +1265,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1032
Private shallExecuteTask
@@ -1278,7 +1278,7 @@ Can be overridden.
workerNodeKey: number
Returns boolean
+Defined in src/pools/abstract-pool.ts:738
Private shallUpdateTaskFunctionWorkerUsage
@@ -1298,7 +1298,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:921
Private startPool
@@ -1306,7 +1306,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:337
Private taskStealingOnEmptyQueue
@@ -1319,7 +1319,7 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1246
Private tasksQueueSize
@@ -1332,7 +1332,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1487
Private tasksStealingOnBackPressure
@@ -1345,7 +1345,7 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1278
Private updateEluWorkerUsage
@@ -1360,7 +1360,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:975
Private updateRunTimeWorkerUsage
@@ -1375,7 +1375,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:948
Private updateTaskStatisticsWorkerUsage
@@ -1390,7 +1390,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:930
Private updateTaskStolenStatisticsWorkerUsage
@@ -1405,7 +1405,7 @@ Can be overridden.
taskName: string
Returns void
+Defined in src/pools/abstract-pool.ts:1227
Private updateWaitTimeWorkerUsage
@@ -1420,7 +1420,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:962
Protected workerListener
@@ -1447,7 +1447,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1321
+
Defined in src/worker/abstract-worker.ts:73
Protected Abstract id
id: number
@@ -172,7 +172,7 @@
+Defined in src/worker/abstract-worker.ts:57
Protected Readonly isMain
isMain: boolean
@@ -180,7 +180,7 @@
+Defined in src/worker/abstract-worker.ts:85
Protected lastTaskTimestamp
lastTaskTimestamp: number
@@ -188,7 +188,7 @@
+Defined in src/worker/abstract-worker.ts:65
Private Readonly mainWorker
mainWorker: MainWorker
@@ -196,7 +196,7 @@
+Defined in src/worker/abstract-worker.ts:86
Protected opts
@@ -204,7 +204,7 @@
+Defined in src/worker/abstract-worker.ts:88
Protected statistics
@@ -212,7 +212,7 @@
+Defined in src/worker/abstract-worker.ts:69
Protected taskFunctions
@@ -220,7 +220,7 @@
+Defined in src/worker/abstract-worker.ts:61
asyncId
@@ -278,7 +278,7 @@ If a task function with the same name already exists, it is replaced.
Optional name: string
+Defined in src/worker/abstract-worker.ts:576
bind
@@ -316,7 +316,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:419
Private checkMessageWorkerId
+Defined in src/worker/abstract-worker.ts:385
Private checkStatistics
@@ -345,7 +345,7 @@ If a task function with the same name already exists, it is replaced.
-
Returns void
+Defined in src/worker/abstract-worker.ts:600
Private checkTaskFunctionName
@@ -358,7 +358,7 @@ If a task function with the same name already exists, it is replaced.
name: string
Returns void
+Defined in src/worker/abstract-worker.ts:308
Private checkTaskFunctions
@@ -377,7 +377,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:132
Private checkValidTaskFunction
@@ -392,7 +392,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:106
Private checkWorkerOptions
@@ -405,7 +405,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:101
emitDestroy
@@ -434,7 +434,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:585
+Defined in src/worker/abstract-worker.ts:434
Protected handleError
@@ -468,7 +468,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:466
Protected handleKillMessage
@@ -487,7 +487,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:351
Protected Abstract handleReadyMessage
@@ -506,7 +506,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:322
+Defined in src/worker/abstract-worker.ts:177
listTaskFunctions
@@ -540,7 +540,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:255
Protected messageListener
@@ -559,7 +559,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:329
+Defined in src/worker/abstract-worker.ts:231
+Defined in src/worker/abstract-worker.ts:476
Protected runAsync
@@ -630,7 +630,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:541
runInAsyncScope
@@ -709,7 +709,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:504
Protected sendTaskFunctionsListToMainWorker
@@ -720,7 +720,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:453
Protected Abstract sendToMainWorker
@@ -739,7 +739,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:446
+Defined in src/worker/abstract-worker.ts:285
Private startCheckActive
@@ -776,7 +776,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:398
Private stopCheckActive
@@ -787,7 +787,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:409
triggerAsyncId
@@ -806,7 +806,7 @@ then restore the original execution context.
-
Returns void
+Defined in src/worker/abstract-worker.ts:606
Static bind
@@ -31,7 +31,7 @@
+
Defined in src/circular-array.ts:10
+
Defined in src/circular-array.ts:13
Properties
@@ -153,7 +153,7 @@ when they will be absent when used in a 'with' statement.
size
size: number
+Defined in src/circular-array.ts:11
Static Readonly [species]
[species]: ArrayConstructor
Returns void
+
Defined in src/circular-array.ts:100
concat
@@ -222,7 +222,7 @@ when they will be absent when used in a 'with' statement.
Inherit Doc
+Defined in src/circular-array.ts:41
copyWithin
@@ -263,7 +263,7 @@ is treated as length+end.
-
Returns boolean
+Defined in src/circular-array.ts:92
entries
@@ -729,7 +729,7 @@ thisArg is omitted, undefined is used as the this value.
-
Returns boolean
+Defined in src/circular-array.ts:96
includes
@@ -910,7 +910,7 @@ If the array is empty, undefined is returned and the array is not modified.
Inherit Doc
+Defined in src/circular-array.ts:23
reduce
@@ -1145,7 +1145,7 @@ If the array is empty, undefined is returned and the array is not modified.
size: number
Returns void
+Defined in src/circular-array.ts:80
reverse
@@ -1301,7 +1301,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
Inherit Doc
+Defined in src/circular-array.ts:56
toLocaleString
@@ -1341,7 +1341,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
Inherit Doc
+Defined in src/circular-array.ts:32
values
@@ -1599,7 +1599,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
- isArray
- of
@@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/cluster-worker.ts:21
@@ -127,7 +127,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/cluster-worker.ts:31
Protected Readonly isMain
isMain: boolean
@@ -147,7 +147,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:85
Protected lastTaskTimestamp
lastTaskTimestamp: number
@@ -156,7 +156,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:65
Protected opts
@@ -165,7 +165,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:88
Protected statistics
@@ -174,7 +174,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:69
Protected taskFunctions
@@ -183,7 +183,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:61
Accessors
@@ -197,7 +197,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/cluster-worker.ts:65
Methods
@@ -232,7 +232,7 @@ If a task function with the same name already exists, it is replaced.
+
Defined in src/worker/abstract-worker.ts:193
asyncId
@@ -301,7 +301,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:434
+Defined in src/worker/abstract-worker.ts:466
Protected handleKillMessage
+Defined in src/worker/abstract-worker.ts:351
Protected handleReadyMessage
+Defined in src/worker/cluster-worker.ts:45
+Defined in src/worker/abstract-worker.ts:177
+Defined in src/worker/abstract-worker.ts:255
Protected messageListener
+Defined in src/worker/abstract-worker.ts:329
+Defined in src/worker/abstract-worker.ts:231
+Defined in src/worker/abstract-worker.ts:476
+Defined in src/worker/abstract-worker.ts:541
+Defined in src/worker/abstract-worker.ts:504
Protected sendTaskFunctionsListToMainWorker
+Defined in src/worker/abstract-worker.ts:453
Protected sendToMainWorker
+Defined in src/worker/cluster-worker.ts:70
+Defined in src/worker/abstract-worker.ts:285
triggerAsyncId
@@ -33,7 +33,7 @@ Implemented with a doubly linked list.
+
Defined in src/deque.ts:26
@@ -77,14 +77,14 @@ Implemented with a doubly linked list.
T
Returns Deque<T>
+
Defined in src/deque.ts:34
maxSize
maxSize: number
@@ -92,7 +92,7 @@ Implemented with a doubly linked list.
+
Defined in src/deque.ts:32
size
size: number
@@ -100,12 +100,12 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:30
+Defined in src/deque.ts:28
+Defined in src/deque.ts:170
clear
@@ -146,7 +146,7 @@ Implemented with a doubly linked list.
Returns void
+Defined in src/deque.ts:131
Private incrementSize
@@ -154,7 +154,7 @@ Implemented with a doubly linked list.
-
Returns number
+Defined in src/deque.ts:194
peekFirst
@@ -166,7 +166,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:116
peekLast
@@ -178,7 +178,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:124
pop
@@ -190,7 +190,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:77
push
@@ -210,7 +210,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:44
shift
@@ -222,7 +222,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:97
unshift
@@ -242,7 +242,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:61
@@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/cluster/dynamic.ts:15
@@ -150,7 +150,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/cluster/dynamic.ts:27
Properties
@@ -171,7 +171,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:68
Protected Readonly filePath
filePath: string
@@ -180,7 +180,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:117
Protected Readonly max
max: number
@@ -189,7 +189,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/cluster/dynamic.ts:29
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -198,7 +198,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:116
Protected Readonly opts
@@ -207,7 +207,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/cluster/fixed.ts:47
Protected promiseResponseMap
@@ -221,7 +221,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:78
Protected workerChoiceStrategyContext
@@ -230,7 +230,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:84
Readonly Internal workerNodes
@@ -239,7 +239,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:65
+
Defined in src/pools/abstract-pool.ts:689
+
Defined in src/pools/abstract-pool.ts:350
+
Defined in src/pools/abstract-pool.ts:562
+
Defined in src/pools/abstract-pool.ts:555
+
Defined in src/pools/abstract-pool.ts:507
+
Defined in src/pools/cluster/dynamic.ts:38
+
Defined in src/pools/abstract-pool.ts:524
+
Defined in src/pools/cluster/fixed.ts:119
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1162
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:858
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:187
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1105
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1061
+
Defined in src/pools/cluster/fixed.ts:109
+
Defined in src/pools/abstract-pool.ts:803
Protected destroyWorkerNode
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:643
+
Defined in src/pools/abstract-pool.ts:747
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1491
+
Defined in src/pools/abstract-pool.ts:1407
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1449
+
Defined in src/pools/abstract-pool.ts:705
+
Defined in src/pools/cluster/fixed.ts:58
+
Defined in src/pools/abstract-pool.ts:726
Protected registerWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:101
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:813
Protected sendStartupMessageToWorker
+
Defined in src/pools/cluster/fixed.ts:93
+
Defined in src/pools/cluster/fixed.ts:85
+
Defined in src/pools/abstract-pool.ts:655
+
Defined in src/pools/abstract-pool.ts:610
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:629
+
Defined in src/pools/cluster/fixed.ts:53
+
Defined in src/pools/abstract-pool.ts:1321
@@ -45,7 +45,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/thread/dynamic.ts:15
@@ -150,7 +150,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/thread/dynamic.ts:27
Properties
@@ -171,7 +171,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:68
Protected Readonly filePath
filePath: string
@@ -180,7 +180,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:117
Protected Readonly max
max: number
@@ -189,7 +189,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/thread/dynamic.ts:29
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -198,7 +198,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:116
Protected Readonly opts
@@ -207,7 +207,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/thread/fixed.ts:49
Protected promiseResponseMap
@@ -221,7 +221,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:78
Protected workerChoiceStrategyContext
@@ -230,7 +230,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:84
Readonly Internal workerNodes
@@ -239,7 +239,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:65
Accessors
@@ -254,7 +254,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/thread/dynamic.ts:43
+
Defined in src/pools/abstract-pool.ts:689
+
Defined in src/pools/abstract-pool.ts:350
+
Defined in src/pools/abstract-pool.ts:562
+
Defined in src/pools/abstract-pool.ts:555
+
Defined in src/pools/abstract-pool.ts:507
+
Defined in src/pools/thread/dynamic.ts:38
+
Defined in src/pools/abstract-pool.ts:524
+
Defined in src/pools/thread/fixed.ts:130
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1162
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:858
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:187
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1105
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1061
+
Defined in src/pools/thread/fixed.ts:117
+
Defined in src/pools/abstract-pool.ts:803
Protected destroyWorkerNode
+
Defined in src/pools/thread/fixed.ts:60
+
Defined in src/pools/abstract-pool.ts:643
+
Defined in src/pools/abstract-pool.ts:747
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1491
+
Defined in src/pools/abstract-pool.ts:1407
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1449
+
Defined in src/pools/abstract-pool.ts:705
+
Defined in src/pools/thread/fixed.ts:55
+
Defined in src/pools/abstract-pool.ts:726
Protected registerWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:107
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:813
Protected sendStartupMessageToWorker
+
Defined in src/pools/thread/fixed.ts:91
+
Defined in src/pools/thread/fixed.ts:80
+
Defined in src/pools/abstract-pool.ts:655
+
Defined in src/pools/abstract-pool.ts:610
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:629
+
Defined in src/pools/abstract-pool.ts:842
+
Defined in src/pools/abstract-pool.ts:1321
@@ -45,7 +45,7 @@
+
Defined in src/pools/cluster/fixed.ts:33
+
Defined in src/pools/cluster/fixed.ts:44
Protected Readonly filePath
filePath: string
@@ -175,7 +175,7 @@
+
Defined in src/pools/abstract-pool.ts:117
Protected Optional Readonly max
max?: number
@@ -184,7 +184,7 @@
+
Defined in src/pools/abstract-pool.ts:93
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -193,7 +193,7 @@
+
Defined in src/pools/abstract-pool.ts:116
Protected Readonly opts
@@ -202,7 +202,7 @@
+
Defined in src/pools/cluster/fixed.ts:47
Protected promiseResponseMap
@@ -216,7 +216,7 @@
+
Defined in src/pools/abstract-pool.ts:78
Protected workerChoiceStrategyContext
@@ -225,7 +225,7 @@
+
Defined in src/pools/abstract-pool.ts:84
Readonly Internal workerNodes
@@ -234,7 +234,7 @@
+
Defined in src/pools/abstract-pool.ts:65
+
Defined in src/pools/abstract-pool.ts:689
+
Defined in src/pools/abstract-pool.ts:350
+
Defined in src/pools/abstract-pool.ts:562
+
Defined in src/pools/abstract-pool.ts:555
+
Defined in src/pools/abstract-pool.ts:507
+
Defined in src/pools/cluster/fixed.ts:114
+
Defined in src/pools/abstract-pool.ts:524
+
Defined in src/pools/cluster/fixed.ts:119
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1162
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:858
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:187
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1105
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1061
+
Defined in src/pools/cluster/fixed.ts:109
+
Defined in src/pools/abstract-pool.ts:803
Protected destroyWorkerNode
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:643
+
Defined in src/pools/abstract-pool.ts:747
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1491
+
Defined in src/pools/abstract-pool.ts:1407
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1449
+
Defined in src/pools/abstract-pool.ts:705
+
Defined in src/pools/cluster/fixed.ts:58
+
Defined in src/pools/abstract-pool.ts:726
Protected registerWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:101
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:813
Protected sendStartupMessageToWorker
+
Defined in src/pools/cluster/fixed.ts:93
+
Defined in src/pools/cluster/fixed.ts:85
+
Defined in src/pools/abstract-pool.ts:655
+
Defined in src/pools/abstract-pool.ts:610
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:629
+
Defined in src/pools/cluster/fixed.ts:53
+
Defined in src/pools/abstract-pool.ts:1321
@@ -45,7 +45,7 @@
+
Defined in src/pools/thread/fixed.ts:35
+
Defined in src/pools/thread/fixed.ts:46
Protected Readonly filePath
filePath: string
@@ -175,7 +175,7 @@
+
Defined in src/pools/abstract-pool.ts:117
Protected Optional Readonly max
max?: number
@@ -184,7 +184,7 @@
+
Defined in src/pools/abstract-pool.ts:93
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -193,7 +193,7 @@
+
Defined in src/pools/abstract-pool.ts:116
Protected Readonly opts
@@ -202,7 +202,7 @@
+
Defined in src/pools/thread/fixed.ts:49
Protected promiseResponseMap
@@ -216,7 +216,7 @@
+
Defined in src/pools/abstract-pool.ts:78
Protected workerChoiceStrategyContext
@@ -225,7 +225,7 @@
+
Defined in src/pools/abstract-pool.ts:84
Readonly Internal workerNodes
@@ -234,7 +234,7 @@
+
Defined in src/pools/abstract-pool.ts:65
+
Defined in src/pools/abstract-pool.ts:689
+
Defined in src/pools/abstract-pool.ts:350
+
Defined in src/pools/abstract-pool.ts:562
+
Defined in src/pools/abstract-pool.ts:555
+
Defined in src/pools/abstract-pool.ts:507
+
Defined in src/pools/thread/fixed.ts:125
+
Defined in src/pools/abstract-pool.ts:524
+
Defined in src/pools/thread/fixed.ts:130
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1162
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:858
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:187
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1105
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1061
+
Defined in src/pools/thread/fixed.ts:117
+
Defined in src/pools/abstract-pool.ts:803
Protected destroyWorkerNode
+
Defined in src/pools/thread/fixed.ts:60
+
Defined in src/pools/abstract-pool.ts:643
+
Defined in src/pools/abstract-pool.ts:747
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1491
+
Defined in src/pools/abstract-pool.ts:1407
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1449
+
Defined in src/pools/abstract-pool.ts:705
+
Defined in src/pools/thread/fixed.ts:55
+
Defined in src/pools/abstract-pool.ts:726
Protected registerWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:107
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:813
Protected sendStartupMessageToWorker
+
Defined in src/pools/thread/fixed.ts:91
+
Defined in src/pools/thread/fixed.ts:80
+
Defined in src/pools/abstract-pool.ts:655
+
Defined in src/pools/abstract-pool.ts:610
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:629
+
Defined in src/pools/abstract-pool.ts:842
+
Defined in src/pools/abstract-pool.ts:1321
@@ -32,7 +32,7 @@
+
Defined in src/deque.ts:9
@@ -67,24 +67,24 @@
data: T
Returns Node<T>
+
Defined in src/deque.ts:14
+
Defined in src/deque.ts:11
+Defined in src/deque.ts:12
@@ -26,7 +26,7 @@
+
Defined in src/pools/pool.ts:39
@@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:26
@@ -128,7 +128,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:40
Protected Readonly isMain
isMain: boolean
@@ -148,7 +148,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:85
Protected lastTaskTimestamp
lastTaskTimestamp: number
@@ -157,7 +157,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:65
Protected opts
@@ -166,7 +166,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:88
Private port
port: MessagePort
@@ -174,7 +174,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:33
Protected statistics
@@ -183,7 +183,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:69
Protected taskFunctions
@@ -192,7 +192,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:61
Accessors
@@ -206,7 +206,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:86
Methods
@@ -241,7 +241,7 @@ If a task function with the same name already exists, it is replaced.
+Defined in src/worker/abstract-worker.ts:193
+Defined in src/worker/abstract-worker.ts:434
+Defined in src/worker/thread-worker.ts:96
Protected handleKillMessage
+Defined in src/worker/thread-worker.ts:79
Protected handleReadyMessage
+Defined in src/worker/thread-worker.ts:54
+Defined in src/worker/abstract-worker.ts:177
+Defined in src/worker/abstract-worker.ts:255
Protected messageListener
+Defined in src/worker/abstract-worker.ts:329
+Defined in src/worker/abstract-worker.ts:231
+Defined in src/worker/abstract-worker.ts:476
+Defined in src/worker/abstract-worker.ts:541
+Defined in src/worker/abstract-worker.ts:504
Protected sendTaskFunctionsListToMainWorker
+Defined in src/worker/abstract-worker.ts:453
Protected sendToMainWorker
+Defined in src/worker/thread-worker.ts:91
+Defined in src/worker/abstract-worker.ts:285
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:40
Private Readonly workerChoiceStrategies
workerChoiceStrategies: Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:32
Private workerChoiceStrategy
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
@@ -139,7 +139,7 @@
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:51
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:119
getTaskStatisticsRequirements
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:132
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:200
setOptions
@@ -218,7 +218,7 @@
Returns void
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:213
setWorkerChoiceStrategy
@@ -237,7 +237,7 @@
Returns void
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:145
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:159
@@ -26,7 +26,7 @@ Always returns a value greater than zero.
+
Defined in src/utils.ts:56
-
poolifier - v2.6.41
+
poolifier - v2.6.42
Index
@@ -110,7 +110,7 @@
Theme
@@ -26,7 +26,7 @@
+
Defined in src/pools/cluster/fixed.ts:10
+
Defined in src/pools/pool.ts:162
Optional enableTasksQueue
enableTasksQueue?: boolean
@@ -72,7 +72,7 @@
+Defined in src/pools/pool.ts:168
+Defined in src/pools/cluster/fixed.ts:16
Optional errorHandler
@@ -91,7 +91,7 @@
+Defined in src/pools/pool.ts:138
Optional exitHandler
@@ -100,7 +100,7 @@
+Defined in src/pools/pool.ts:142
Optional messageHandler
@@ -109,7 +109,7 @@
+Defined in src/pools/pool.ts:134
Optional onlineHandler
@@ -118,7 +118,7 @@
+Defined in src/pools/pool.ts:130
Optional restartWorkerOnError
restartWorkerOnError?: boolean
@@ -127,7 +127,7 @@
+Defined in src/pools/pool.ts:156
+Defined in src/pools/cluster/fixed.ts:22
Optional tasksQueueOptions
@@ -146,7 +146,7 @@
+Defined in src/pools/pool.ts:172
Optional workerChoiceStrategy
workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -158,7 +158,7 @@
+Defined in src/pools/pool.ts:148
Optional workerChoiceStrategyOptions
@@ -167,7 +167,7 @@
+Defined in src/pools/pool.ts:152
@@ -24,7 +24,7 @@
- EventLoopUtilizationMeasurementStatistics
+
Defined in src/pools/worker.ts:71
+
Defined in src/pools/worker.ts:72
Optional utilization
utilization?: number
+
Defined in src/pools/worker.ts:74
@@ -46,7 +46,7 @@
+
Defined in src/pools/pool.ts:182
@@ -83,7 +83,7 @@
Returns Promise<void>
+
Defined in src/pools/pool.ts:235
Optional Readonly emitter
@@ -101,7 +101,7 @@
+Defined in src/pools/pool.ts:218
Readonly enableTasksQueue
enableTasksQueue: ((enable, tasksQueueOptions?) => void)
@@ -130,7 +130,7 @@
Returns void
+Defined in src/pools/pool.ts:266
Readonly execute
execute: ((data?, name?, transferList?) => Promise<Response>)
@@ -165,7 +165,7 @@
+Defined in src/pools/pool.ts:227
Readonly hasWorkerNodeBackPressure
hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
@@ -190,7 +190,7 @@
+Defined in src/pools/pool.ts:204
Readonly info
@@ -198,7 +198,7 @@
+Defined in src/pools/pool.ts:190
Readonly listTaskFunctions
listTaskFunctions: (() => string[])
@@ -215,7 +215,7 @@
+Defined in src/pools/pool.ts:241
Readonly setTasksQueueOptions
setTasksQueueOptions: ((tasksQueueOptions) => void)
@@ -239,7 +239,7 @@
Returns void
+Defined in src/pools/pool.ts:275
Readonly setWorkerChoiceStrategy
setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
@@ -268,7 +268,7 @@
Returns void
+Defined in src/pools/pool.ts:248
Readonly setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
@@ -292,7 +292,7 @@
Returns void
+Defined in src/pools/pool.ts:257
Readonly Internal workerNodes
@@ -300,7 +300,7 @@
+Defined in src/pools/pool.ts:196
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:186
+
Defined in src/pools/worker.ts:190
Readonly on
on: ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void)
@@ -118,7 +118,7 @@
Param
The event handler.
+Defined in src/pools/worker.ts:198
Readonly once
once: ((event, handler) => void)
@@ -147,12 +147,12 @@
Returns void
+Defined in src/pools/worker.ts:208
Optional Readonly threadId
threadId?: number
+Defined in src/pools/worker.ts:191
@@ -24,7 +24,7 @@
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:168
@@ -59,7 +59,7 @@ If the worker node is not eligible, undefined is returned.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:195
Readonly remove
remove: ((workerNodeKey) => boolean)
@@ -84,7 +84,7 @@ If the worker node is not eligible, undefined is returned.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:202
Readonly reset
reset: (() => boolean)
@@ -101,7 +101,7 @@ If the worker node is not eligible, undefined is returned.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:182
Readonly setOptions
setOptions: ((opts) => void)
@@ -125,7 +125,7 @@ If the worker node is not eligible, undefined is returned.
Returns void
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:208
Readonly strategyPolicy
@@ -133,7 +133,7 @@ If the worker node is not eligible, undefined is returned.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:172
Readonly taskStatisticsRequirements
@@ -141,7 +141,7 @@ If the worker node is not eligible, undefined is returned.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:176
Readonly update
update: ((workerNodeKey) => boolean)
@@ -163,7 +163,7 @@ If the worker node is not eligible, undefined is returned.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:188
@@ -37,7 +37,7 @@
+
Defined in src/pools/worker.ts:226
@@ -81,7 +81,7 @@
Returns void
+
Defined in src/pools/worker.ts:296
Readonly closeChannel
closeChannel: (() => void)
@@ -97,7 +97,7 @@
Returns void
+Defined in src/pools/worker.ts:310
Readonly dequeueTask
dequeueTask: (() => undefined | Task<Data>)
@@ -114,7 +114,7 @@
+Defined in src/pools/worker.ts:286
Readonly enqueueTask
enqueueTask: ((task) => number)
@@ -139,7 +139,7 @@
+Defined in src/pools/worker.ts:273
Readonly getTaskFunctionWorkerUsage
getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
@@ -164,7 +164,7 @@
+Defined in src/pools/worker.ts:317
Readonly hasBackPressure
hasBackPressure: (() => boolean)
@@ -181,7 +181,7 @@
+Defined in src/pools/worker.ts:302
Readonly info
@@ -189,7 +189,7 @@
+Defined in src/pools/worker.ts:234
Optional Readonly messageChannel
messageChannel?: MessageChannel
@@ -197,7 +197,7 @@
+Defined in src/pools/worker.ts:247
Optional onBackPressure
@@ -205,7 +205,7 @@
+Defined in src/pools/worker.ts:256
Optional onEmptyQueue
@@ -213,7 +213,7 @@
+Defined in src/pools/worker.ts:260
Readonly popTask
popTask: (() => undefined | Task<Data>)
@@ -230,7 +230,7 @@
+Defined in src/pools/worker.ts:292
Readonly resetUsage
resetUsage: (() => void)
@@ -246,7 +246,7 @@
Returns void
+Defined in src/pools/worker.ts:306
Optional strategyData
@@ -255,7 +255,7 @@ This is used to store data that is specific to the worker choice strategy.
+Defined in src/pools/worker.ts:243
tasksQueueBackPressureSize
tasksQueueBackPressureSize: number
@@ -264,7 +264,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:252
Readonly tasksQueueSize
tasksQueueSize: (() => number)
@@ -281,7 +281,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:266
Readonly unshiftTask
unshiftTask: ((task) => number)
@@ -306,7 +306,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:280
Readonly usage
@@ -314,7 +314,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:238
Readonly worker
worker: Worker
@@ -322,7 +322,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:230
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:63
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:39
+
Defined in src/pools/worker.ts:43
Optional average
average?: number
@@ -56,7 +56,7 @@
+Defined in src/pools/worker.ts:55
Readonly history
@@ -64,7 +64,7 @@
+Defined in src/pools/worker.ts:63
Optional maximum
maximum?: number
@@ -72,7 +72,7 @@
+Defined in src/pools/worker.ts:51
Optional median
median?: number
@@ -80,7 +80,7 @@
+Defined in src/pools/worker.ts:59
Optional minimum
minimum?: number
@@ -88,7 +88,7 @@
+Defined in src/pools/worker.ts:47
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:120
median
median: boolean
@@ -61,7 +61,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:124
@@ -39,7 +39,7 @@
+
Defined in src/utility-types.ts:105
+
Defined in src/utility-types.ts:134
Optional Readonly data
data?: Data
@@ -80,7 +80,7 @@
+
Defined in src/utility-types.ts:83
Optional Readonly kill
kill?: true | "success" | "SOFT" | "HARD" | "failure"
@@ -88,7 +88,7 @@
+Defined in src/utility-types.ts:110
Optional Readonly name
name?: string
@@ -97,7 +97,7 @@
+Defined in src/utility-types.ts:79
Optional Readonly port
port?: MessagePort
@@ -105,7 +105,7 @@
+Defined in src/utility-types.ts:138
Optional Readonly ready
ready?: boolean
@@ -113,7 +113,7 @@
+Defined in src/utility-types.ts:130
Optional Readonly statistics
@@ -121,7 +121,7 @@
+Defined in src/utility-types.ts:126
Optional Readonly taskError
@@ -129,7 +129,7 @@
+Defined in src/utility-types.ts:114
Optional Readonly taskFunctions
taskFunctions?: string[]
@@ -137,7 +137,7 @@
+Defined in src/utility-types.ts:122
Optional Readonly taskId
taskId?: string
@@ -146,7 +146,7 @@
+Defined in src/utility-types.ts:95
Optional Readonly taskPerformance
@@ -154,7 +154,7 @@
+Defined in src/utility-types.ts:118
Optional Readonly timestamp
timestamp?: number
@@ -163,7 +163,7 @@
+Defined in src/utility-types.ts:91
Optional Readonly transferList
transferList?: TransferListItem[]
@@ -172,7 +172,7 @@
+Defined in src/utility-types.ts:87
Readonly workerId
workerId: number
@@ -181,7 +181,7 @@
+Defined in src/utility-types.ts:75
@@ -24,7 +24,7 @@
+
Defined in src/pools/pool.ts:62
@@ -59,7 +59,7 @@
Optional Readonly backPressure
backPressure?: boolean
Readonly busyWorkerNodes
busyWorkerNodes: number
@@ -67,22 +67,22 @@
+
Defined in src/pools/pool.ts:77
Readonly executedTasks
executedTasks: number
+
Defined in src/pools/pool.ts:78
Readonly executingTasks
executingTasks: number
+
Defined in src/pools/pool.ts:79
Readonly failedTasks
failedTasks: number
+
Defined in src/pools/pool.ts:84
Readonly idleWorkerNodes
idleWorkerNodes: number
@@ -90,32 +90,32 @@
+Defined in src/pools/pool.ts:75
Optional Readonly maxQueuedTasks
maxQueuedTasks?: number
+Defined in src/pools/pool.ts:81
Readonly maxSize
maxSize: number
+Defined in src/pools/pool.ts:69
Readonly minSize
minSize: number
+Defined in src/pools/pool.ts:68
Optional Readonly queuedTasks
queuedTasks?: number
+Defined in src/pools/pool.ts:80
Readonly ready
ready: boolean
+Defined in src/pools/pool.ts:66
Optional Readonly runTime
runTime?: {
    average?: number;
    maximum: number;
    median?: number;
    minimum: number;
}
@@ -131,22 +131,22 @@
Readonly minimum: number
+Defined in src/pools/pool.ts:85
Optional Readonly stolenTasks
stolenTasks?: number
+Defined in src/pools/pool.ts:83
Readonly strategy
strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+Defined in src/pools/pool.ts:67
Readonly type
type: "fixed" | "dynamic"
+Defined in src/pools/pool.ts:64
Optional Readonly utilization
utilization?: number
@@ -154,12 +154,12 @@
+Defined in src/pools/pool.ts:71
Readonly version
version: string
+Defined in src/pools/pool.ts:63
Optional Readonly waitTime
waitTime?: {
    average?: number;
    maximum: number;
    median?: number;
    minimum: number;
}
@@ -175,12 +175,12 @@
Readonly minimum: number
+Defined in src/pools/pool.ts:91
Readonly worker
worker: "thread" | "cluster"
+Defined in src/pools/pool.ts:65
Readonly workerNodes
workerNodes: number
@@ -188,7 +188,7 @@
+Defined in src/pools/pool.ts:73
+
Defined in src/pools/pool.ts:162
Optional enableTasksQueue
enableTasksQueue?: boolean
@@ -77,7 +77,7 @@
+Defined in src/pools/pool.ts:168
Optional errorHandler
@@ -85,7 +85,7 @@
+Defined in src/pools/pool.ts:138
Optional exitHandler
@@ -93,7 +93,7 @@
+Defined in src/pools/pool.ts:142
Optional messageHandler
@@ -101,7 +101,7 @@
+Defined in src/pools/pool.ts:134
Optional onlineHandler
@@ -109,7 +109,7 @@
+Defined in src/pools/pool.ts:130
Optional restartWorkerOnError
restartWorkerOnError?: boolean
@@ -117,7 +117,7 @@
+Defined in src/pools/pool.ts:156
Optional tasksQueueOptions
@@ -125,7 +125,7 @@
+Defined in src/pools/pool.ts:172
Optional workerChoiceStrategy
workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -136,7 +136,7 @@
+Defined in src/pools/pool.ts:148
Optional workerChoiceStrategyOptions
@@ -144,7 +144,7 @@
+Defined in src/pools/pool.ts:152
@@ -32,7 +32,7 @@
+
Defined in src/utility-types.ts:147
@@ -66,7 +66,7 @@
Returns void
+
Defined in src/utility-types.ts:155
Readonly resolve
resolve: ((value) => void)
@@ -87,7 +87,7 @@
Returns void
+Defined in src/utility-types.ts:151
Readonly workerNodeKey
workerNodeKey: number
@@ -95,7 +95,7 @@
+Defined in src/utility-types.ts:159
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:179
@@ -40,7 +40,7 @@
Optional virtualTaskEndTimestamp
virtualTaskEndTimestamp?: number
+
Defined in src/pools/worker.ts:180
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:160
Readonly dynamicWorkerUsage
dynamicWorkerUsage: boolean
@@ -52,7 +52,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:156
@@ -34,7 +34,7 @@
+
Defined in src/utility-types.ts:71
+
Defined in src/utility-types.ts:83
Optional Readonly name
name?: string
@@ -66,7 +66,7 @@
+Defined in src/utility-types.ts:79
Optional Readonly taskId
taskId?: string
@@ -74,7 +74,7 @@
+Defined in src/utility-types.ts:95
Optional Readonly timestamp
timestamp?: number
@@ -82,7 +82,7 @@
+Defined in src/utility-types.ts:91
Optional Readonly transferList
transferList?: TransferListItem[]
@@ -90,7 +90,7 @@
+Defined in src/utility-types.ts:87
Readonly workerId
workerId: number
@@ -98,7 +98,7 @@
+Defined in src/utility-types.ts:75
@@ -32,7 +32,7 @@
+
Defined in src/utility-types.ts:10
+
Defined in src/utility-types.ts:22
Readonly message
message: string
@@ -61,7 +61,7 @@
+Defined in src/utility-types.ts:18
Readonly name
name: string
@@ -69,7 +69,7 @@
+Defined in src/utility-types.ts:14
@@ -24,7 +24,7 @@
+
Defined in src/utility-types.ts:30
+
Defined in src/utility-types.ts:46
Readonly name
name: string
@@ -54,7 +54,7 @@
+Defined in src/utility-types.ts:34
Optional Readonly runTime
runTime?: number
@@ -62,7 +62,7 @@
+Defined in src/utility-types.ts:42
Readonly timestamp
timestamp: number
@@ -70,7 +70,7 @@
+Defined in src/utility-types.ts:38
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:82
+
Defined in src/pools/worker.ts:86
executing
executing: number
@@ -56,7 +56,7 @@
+Defined in src/pools/worker.ts:90
failed
failed: number
@@ -64,7 +64,7 @@
+Defined in src/pools/worker.ts:106
Optional Readonly maxQueued
maxQueued?: number
@@ -72,7 +72,7 @@
+Defined in src/pools/worker.ts:98
Readonly queued
queued: number
@@ -80,7 +80,7 @@
+Defined in src/pools/worker.ts:94
stolen
stolen: number
@@ -88,7 +88,7 @@
+Defined in src/pools/worker.ts:102
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:136
Readonly waitTime
@@ -61,7 +61,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:140
@@ -24,7 +24,7 @@
+
Defined in src/pools/pool.ts:102
+
Defined in src/pools/pool.ts:118
Optional Readonly queueMaxSize
queueMaxSize?: number
@@ -56,7 +56,7 @@
Deprecated
Use size instead.
+Defined in src/pools/pool.ts:112
Optional Readonly size
size?: number
@@ -67,7 +67,7 @@
+Defined in src/pools/pool.ts:108
@@ -26,7 +26,7 @@
+
Defined in src/pools/thread/fixed.ts:18
+
Defined in src/pools/pool.ts:162
Optional enableTasksQueue
enableTasksQueue?: boolean
@@ -71,7 +71,7 @@
+Defined in src/pools/pool.ts:168
Optional errorHandler
@@ -80,7 +80,7 @@
+Defined in src/pools/pool.ts:138
Optional exitHandler
@@ -89,7 +89,7 @@
+Defined in src/pools/pool.ts:142
Optional messageHandler
@@ -98,7 +98,7 @@
+Defined in src/pools/pool.ts:134
Optional onlineHandler
@@ -107,7 +107,7 @@
+Defined in src/pools/pool.ts:130
Optional restartWorkerOnError
restartWorkerOnError?: boolean
@@ -116,7 +116,7 @@
+Defined in src/pools/pool.ts:156
Optional tasksQueueOptions
@@ -125,7 +125,7 @@
+Defined in src/pools/pool.ts:172
Optional workerChoiceStrategy
workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -137,7 +137,7 @@
+Defined in src/pools/pool.ts:148
Optional workerChoiceStrategyOptions
@@ -146,7 +146,7 @@
+Defined in src/pools/pool.ts:152
+Defined in src/pools/thread/fixed.ts:24
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:97
Optional Readonly measurement
measurement?: "runTime" | "waitTime" | "elu"
@@ -59,7 +59,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:79
Optional Readonly retries
retries?: number
@@ -70,7 +70,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:75
Optional Readonly runTime
@@ -81,7 +81,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:85
Optional Readonly waitTime
@@ -92,7 +92,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:91
Optional Readonly weights
weights?: Record<number, number>
@@ -104,7 +104,7 @@ A weight is tasks maximum execution time in milliseconds for a worker node.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:104
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:127
+
Defined in src/pools/worker.ts:139
Readonly id
id: undefined | number
@@ -55,7 +55,7 @@
+Defined in src/pools/worker.ts:131
ready
ready: boolean
@@ -63,7 +63,7 @@
+Defined in src/pools/worker.ts:143
Optional taskFunctions
taskFunctions?: string[]
@@ -71,7 +71,7 @@
+Defined in src/pools/worker.ts:147
Readonly type
type: "thread" | "cluster"
@@ -79,7 +79,7 @@
+Defined in src/pools/worker.ts:135
@@ -24,7 +24,7 @@
+
Defined in src/worker/worker-options.ts:28
@@ -51,7 +51,7 @@
Deprecated
This option will be removed in the next major version.
+
Defined in src/worker/worker-options.ts:63
Optional killBehavior
killBehavior?: "SOFT" | "HARD"
@@ -67,7 +67,7 @@
+Defined in src/worker/worker-options.ts:39
Optional killHandler
@@ -75,7 +75,7 @@
+Defined in src/worker/worker-options.ts:56
Optional maxInactiveTime
maxInactiveTime?: number
@@ -93,7 +93,7 @@ when this timeout expires your tasks is interrupted before completion and remove
+Defined in src/worker/worker-options.ts:52
@@ -24,7 +24,7 @@
+
Defined in src/utility-types.ts:54
+
Defined in src/utility-types.ts:62
Readonly runTime
runTime: boolean
@@ -52,7 +52,7 @@
+Defined in src/utility-types.ts:58
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:155
+
Defined in src/pools/worker.ts:171
Readonly runTime
@@ -54,7 +54,7 @@
+Defined in src/pools/worker.ts:163
Readonly tasks
@@ -62,7 +62,7 @@
+Defined in src/pools/worker.ts:159
Readonly waitTime
@@ -70,7 +70,7 @@
+Defined in src/pools/worker.ts:167
@@ -40,7 +40,7 @@
Returns void
+Defined in src/pools/worker.ts:21
@@ -40,7 +40,7 @@
Returns void
+Defined in src/pools/worker.ts:29
+Defined in src/worker/worker-options.ts:18
@@ -28,7 +28,7 @@
Returns void | Promise<void>
+Defined in src/worker/worker-options.ts:23
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:54
@@ -40,7 +40,7 @@
Returns void
+Defined in src/pools/worker.ts:13
@@ -38,7 +38,7 @@
Returns void
+Defined in src/pools/worker.ts:8
+Defined in src/pools/pool.ts:57
+Defined in src/pools/pool.ts:34
@@ -47,7 +47,7 @@ This function must return a promise.
Returns Promise<Response>
+Defined in src/worker/task-functions.ts:18
@@ -34,7 +34,7 @@ This function can be synchronous or asynchronous.
+
Defined in src/worker/task-functions.ts:29
@@ -36,7 +36,7 @@ The value is the function itself.
+
Defined in src/worker/task-functions.ts:42
@@ -46,7 +46,7 @@
Returns Response
+Defined in src/worker/task-functions.ts:7
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:40
@@ -36,7 +36,7 @@
Returns void
+Defined in src/pools/worker.ts:217
+Defined in src/pools/worker.ts:120
+Defined in src/worker/worker-options.ts:4
@@ -29,7 +29,7 @@
Readonly waitTime: "waitTime"
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:45
@@ -37,7 +37,7 @@
Readonly taskError: "taskError"
+Defined in src/pools/pool.ts:44
+Defined in src/pools/pool.ts:20
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
@@ -27,7 +27,7 @@
Readonly thread: "thread"
+Defined in src/pools/worker.ts:112