From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Date: Wed, 30 Aug 2023 21:03:41 +0000 (+0000)
Subject: chore: generate documentation
X-Git-Tag: v2.6.40~23
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=adab53c70d781f8c26e35b7359efa3d05c278fa8;p=poolifier.git
chore: generate documentation
---
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index e81c6e15..95e8ad65 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-AbstractPool | poolifier - v2.6.38
+AbstractPool | poolifier - v2.6.39
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:57
@@ -188,7 +188,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:113
Protected Readonly filePath
filePath: string
@@ -217,7 +217,7 @@
+
Defined in src/pools/abstract-pool.ts:115
Protected Optional Readonly max
max?: number
@@ -225,7 +225,7 @@
+Defined in src/pools/abstract-pool.ts:91
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -233,7 +233,7 @@
+Defined in src/pools/abstract-pool.ts:114
Protected Readonly opts
@@ -241,7 +241,7 @@
+Defined in src/pools/abstract-pool.ts:116
Protected promiseResponseMap
@@ -254,7 +254,7 @@
+Defined in src/pools/abstract-pool.ts:76
Private Readonly startTimestamp
startTimestamp: number
@@ -262,7 +262,7 @@
+Defined in src/pools/abstract-pool.ts:104
Private started
started: boolean
@@ -270,7 +270,7 @@
+Defined in src/pools/abstract-pool.ts:100
Private Readonly starting
starting: boolean
@@ -278,7 +278,7 @@
+Defined in src/pools/abstract-pool.ts:96
Protected workerChoiceStrategyContext
@@ -286,7 +286,7 @@
+Defined in src/pools/abstract-pool.ts:82
Readonly Internal workerNodes
@@ -295,7 +295,7 @@
+Defined in src/pools/abstract-pool.ts:63
Protected full
@@ -321,7 +321,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:687
+Defined in src/pools/abstract-pool.ts:348
Protected maxSize
@@ -344,7 +344,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:560
Protected minSize
@@ -355,7 +355,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:553
Private ready
@@ -366,7 +366,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:505
Protected Abstract type
@@ -378,7 +378,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:543
+Defined in src/pools/abstract-pool.ts:522
Protected Abstract worker
@@ -401,7 +401,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:548
Protected afterTaskExecutionHook
@@ -447,7 +447,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:886
Protected afterWorkerNodeSetup
@@ -466,7 +466,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1160
Protected beforeTaskExecutionHook
@@ -489,7 +489,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:856
Private buildTasksQueueOptions
@@ -502,7 +502,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:670
Private checkAndEmitDynamicWorkerCreationEvents
@@ -510,7 +510,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1402
Private checkAndEmitTaskExecutionEvents
@@ -518,7 +518,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1390
Private checkAndEmitTaskQueuingEvents
@@ -526,7 +526,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1396
Protected checkDynamicPoolSize
@@ -541,7 +541,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:185
Private checkFilePath
@@ -554,7 +554,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:154
Private checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:570
Private checkNumberOfWorkers
@@ -587,7 +587,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:167
Private checkPoolOptions
@@ -600,7 +600,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:211
Private checkValidTasksQueueOptions
@@ -613,7 +613,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:293
Private checkValidWorkerChoiceStrategy
@@ -626,7 +626,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:239
Private checkValidWorkerChoiceStrategyOptions
@@ -639,7 +639,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:249
Private chooseWorkerNode
@@ -652,7 +652,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1013
Protected createAndSetupDynamicWorkerNode
@@ -664,7 +664,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1103
Protected createAndSetupWorkerNode
@@ -676,7 +676,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1059
Protected Abstract createWorker
@@ -688,7 +688,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1052
Private dequeueTask
@@ -701,7 +701,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1492
+Defined in src/pools/abstract-pool.ts:801
Protected Abstract destroyWorkerNode
@@ -731,7 +731,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:832
+Defined in src/pools/abstract-pool.ts:641
Private enqueueTask
@@ -769,7 +769,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1486
+Defined in src/pools/abstract-pool.ts:745
Private executeTask
@@ -819,7 +819,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1480
Protected flushTasksQueue
@@ -832,7 +832,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1500
Private flushTasksQueues
@@ -840,7 +840,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1510
Protected getWorkerInfo
@@ -859,7 +859,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1416
Private getWorkerNodeKeyByWorker
@@ -878,7 +878,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:589
Private getWorkerNodeKeyByWorkerId
@@ -897,7 +897,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:601
Private handleTaskExecutionResponse
@@ -910,7 +910,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1362
Private handleWorkerReadyResponse
@@ -923,7 +923,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1348
Private hasBackPressure
@@ -931,7 +931,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1465
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1458
Protected internalBusy
@@ -963,7 +963,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:703
Protected Abstract isMain
@@ -974,7 +974,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:847
+Defined in src/pools/abstract-pool.ts:724
Private redistributeQueuedTasks
@@ -1000,7 +1000,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1200
Protected Abstract registerWorkerMessageListener
@@ -1038,7 +1038,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1147
Private removeWorkerNode
@@ -1056,7 +1056,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1449
Protected sendKillMessageToWorker
@@ -1071,7 +1071,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:811
Protected Abstract sendStartupMessageToWorker
@@ -1089,7 +1089,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1180
Private sendStatisticsMessageToWorker
@@ -1107,7 +1107,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1187
Protected Abstract sendToWorker
@@ -1133,7 +1133,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1041
+Defined in src/pools/abstract-pool.ts:653
Private setTasksQueueSize
@@ -1165,7 +1165,7 @@ Can be overridden.
size: number
Returns void
+Defined in src/pools/abstract-pool.ts:664
+Defined in src/pools/abstract-pool.ts:608
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:627
Protected setupHook
@@ -1219,7 +1219,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:840
Private shallCreateDynamicWorker
@@ -1231,7 +1231,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1030
Private shallExecuteTask
@@ -1244,7 +1244,7 @@ Can be overridden.
workerNodeKey: number
Returns boolean
+Defined in src/pools/abstract-pool.ts:736
Private shallUpdateTaskFunctionWorkerUsage
@@ -1263,7 +1263,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:919
Private startPool
@@ -1271,7 +1271,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:335
Private taskStealingOnEmptyQueue
@@ -1284,7 +1284,7 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1250
Private tasksQueueSize
@@ -1297,7 +1297,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1496
Private tasksStealingOnBackPressure
@@ -1310,7 +1310,7 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1286
Private updateEluWorkerUsage
@@ -1325,7 +1325,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:973
Private updateRunTimeWorkerUsage
@@ -1340,7 +1340,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:946
Private updateTaskStatisticsWorkerUsage
@@ -1355,7 +1355,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:928
Private updateTaskStolenStatisticsWorkerUsage
@@ -1370,7 +1370,7 @@ Can be overridden.
taskName: string
Returns void
+Defined in src/pools/abstract-pool.ts:1231
Private updateWaitTimeWorkerUsage
@@ -1385,7 +1385,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:960
Protected workerListener
@@ -1412,7 +1412,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1328
+
Defined in src/worker/abstract-worker.ts:73
Protected Abstract id
id: number
@@ -167,7 +167,7 @@
+Defined in src/worker/abstract-worker.ts:57
Protected Readonly isMain
isMain: boolean
@@ -175,7 +175,7 @@
+Defined in src/worker/abstract-worker.ts:85
Protected lastTaskTimestamp
lastTaskTimestamp: number
@@ -183,7 +183,7 @@
+Defined in src/worker/abstract-worker.ts:65
Private Readonly mainWorker
mainWorker: MainWorker
@@ -191,7 +191,7 @@
+Defined in src/worker/abstract-worker.ts:86
Protected opts
@@ -199,7 +199,7 @@
+Defined in src/worker/abstract-worker.ts:88
Protected statistics
@@ -207,7 +207,7 @@
+Defined in src/worker/abstract-worker.ts:69
Protected taskFunctions
@@ -215,7 +215,7 @@
+Defined in src/worker/abstract-worker.ts:61
asyncId
@@ -271,7 +271,7 @@ If a task function with the same name already exists, it is replaced.
Optional name: string
Optional
+Defined in src/worker/abstract-worker.ts:576
bind
@@ -308,7 +308,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
@@ -336,7 +336,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
@@ -349,7 +349,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
@@ -367,7 +367,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
@@ -382,7 +382,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
@@ -395,7 +395,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
@@ -424,7 +424,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:585
+Defined in src/worker/abstract-worker.ts:434
Protected handleError
@@ -457,7 +457,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:466
Protected handleKillMessage
@@ -475,7 +475,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:351
Protected Abstract handleReadyMessage
@@ -493,7 +493,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:322
+Defined in src/worker/abstract-worker.ts:177
listTaskFunctions
@@ -526,7 +526,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:255
Protected messageListener
@@ -544,7 +544,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
@@ -611,7 +611,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:541
runInAsyncScope
@@ -685,7 +685,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:504
Protected sendTaskFunctionsListToMainWorker
@@ -696,7 +696,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:453
Protected Abstract sendToMainWorker
@@ -714,7 +714,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
@@ -750,7 +750,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:398
Private stopCheckActive
@@ -761,7 +761,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:409
triggerAsyncId
@@ -780,7 +780,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
@@ -221,7 +221,7 @@ when they will be absent when used in a 'with' statement.
Inherit Doc
+Defined in src/circular-array.ts:41
copyWithin
@@ -259,7 +259,7 @@ is treated as length+end.
-
Returns boolean
+Defined in src/circular-array.ts:92
entries
@@ -705,7 +705,7 @@ thisArg is omitted, undefined is used as the this value.
-
Returns boolean
+Defined in src/circular-array.ts:96
includes
@@ -877,7 +877,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
@@ -1106,7 +1106,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
@@ -1257,7 +1257,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
Inherit Doc
+Defined in src/circular-array.ts:56
toLocaleString
@@ -1297,7 +1297,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
Inherit Doc
+Defined in src/circular-array.ts:32
values
@@ -1546,7 +1546,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
@@ -125,7 +125,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/cluster-worker.ts:31
Protected Readonly isMain
isMain: boolean
@@ -145,7 +145,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:85
Protected lastTaskTimestamp
lastTaskTimestamp: number
@@ -154,7 +154,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:65
Protected opts
@@ -163,7 +163,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:88
Protected statistics
@@ -172,7 +172,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:69
Protected taskFunctions
@@ -181,7 +181,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:61
Accessors
@@ -195,7 +195,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/cluster-worker.ts:65
Methods
@@ -228,7 +228,7 @@ If a task function with the same name already exists, it is replaced.
+
Defined in src/worker/abstract-worker.ts:193
asyncId
@@ -296,7 +296,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
@@ -209,7 +209,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:44
shift
@@ -221,7 +221,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:97
unshift
@@ -240,7 +240,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
@@ -146,7 +146,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
@@ -167,7 +167,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:66
Protected Readonly filePath
filePath: string
@@ -176,7 +176,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:115
Protected Readonly max
max: number
@@ -185,7 +185,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
@@ -194,7 +194,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:114
Protected Readonly opts
@@ -203,7 +203,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
@@ -217,7 +217,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:76
Protected workerChoiceStrategyContext
@@ -226,7 +226,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:82
Readonly Internal workerNodes
@@ -235,7 +235,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:63
+
Defined in src/pools/abstract-pool.ts:687
+
Defined in src/pools/abstract-pool.ts:348
+
Defined in src/pools/abstract-pool.ts:560
+
Defined in src/pools/abstract-pool.ts:553
+
Defined in src/pools/abstract-pool.ts:505
+
Defined in src/pools/cluster/dynamic.ts:38
+
Defined in src/pools/abstract-pool.ts:522
+
Defined in src/pools/cluster/fixed.ts:119
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1160
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:856
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:185
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1103
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1059
+
Defined in src/pools/cluster/fixed.ts:109
+
Defined in src/pools/abstract-pool.ts:801
Protected destroyWorkerNode
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:641
+
Defined in src/pools/abstract-pool.ts:745
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1500
+
Defined in src/pools/abstract-pool.ts:1416
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1458
+
Defined in src/pools/abstract-pool.ts:703
+
Defined in src/pools/cluster/fixed.ts:58
+
Defined in src/pools/abstract-pool.ts:724
Protected registerWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:101
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:811
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:653
+
Defined in src/pools/abstract-pool.ts:608
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:627
+
Defined in src/pools/cluster/fixed.ts:53
+
Defined in src/pools/abstract-pool.ts:1328
@@ -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
@@ -146,7 +146,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
@@ -167,7 +167,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:66
Protected Readonly filePath
filePath: string
@@ -176,7 +176,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:115
Protected Readonly max
max: number
@@ -185,7 +185,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
@@ -194,7 +194,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:114
Protected Readonly opts
@@ -203,7 +203,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
@@ -217,7 +217,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:76
Protected workerChoiceStrategyContext
@@ -226,7 +226,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:82
Readonly Internal workerNodes
@@ -235,7 +235,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:63
Accessors
@@ -250,7 +250,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:687
+
Defined in src/pools/abstract-pool.ts:348
+
Defined in src/pools/abstract-pool.ts:560
+
Defined in src/pools/abstract-pool.ts:553
+
Defined in src/pools/abstract-pool.ts:505
+
Defined in src/pools/thread/dynamic.ts:38
+
Defined in src/pools/abstract-pool.ts:522
+
Defined in src/pools/thread/fixed.ts:130
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1160
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:856
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:185
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1103
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1059
+
Defined in src/pools/thread/fixed.ts:117
+
Defined in src/pools/abstract-pool.ts:801
Protected destroyWorkerNode
+
Defined in src/pools/thread/fixed.ts:60
+
Defined in src/pools/abstract-pool.ts:641
+
Defined in src/pools/abstract-pool.ts:745
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1500
+
Defined in src/pools/abstract-pool.ts:1416
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1458
+
Defined in src/pools/abstract-pool.ts:703
+
Defined in src/pools/thread/fixed.ts:55
+
Defined in src/pools/abstract-pool.ts:724
Protected registerWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:107
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:811
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:653
+
Defined in src/pools/abstract-pool.ts:608
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:627
+
Defined in src/pools/abstract-pool.ts:840
+
Defined in src/pools/abstract-pool.ts:1328
@@ -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
@@ -172,7 +172,7 @@
+
Defined in src/pools/abstract-pool.ts:115
Protected Optional Readonly max
max?: number
@@ -181,7 +181,7 @@
+
Defined in src/pools/abstract-pool.ts:91
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -190,7 +190,7 @@
+
Defined in src/pools/abstract-pool.ts:114
Protected Readonly opts
@@ -199,7 +199,7 @@
+
Defined in src/pools/cluster/fixed.ts:47
Protected promiseResponseMap
@@ -213,7 +213,7 @@
+
Defined in src/pools/abstract-pool.ts:76
Protected workerChoiceStrategyContext
@@ -222,7 +222,7 @@
+
Defined in src/pools/abstract-pool.ts:82
Readonly Internal workerNodes
@@ -231,7 +231,7 @@
+
Defined in src/pools/abstract-pool.ts:63
+
Defined in src/pools/abstract-pool.ts:687
+
Defined in src/pools/abstract-pool.ts:348
+
Defined in src/pools/abstract-pool.ts:560
+
Defined in src/pools/abstract-pool.ts:553
+
Defined in src/pools/abstract-pool.ts:505
+
Defined in src/pools/cluster/fixed.ts:114
+
Defined in src/pools/abstract-pool.ts:522
+
Defined in src/pools/cluster/fixed.ts:119
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1160
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:856
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:185
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1103
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1059
+
Defined in src/pools/cluster/fixed.ts:109
+
Defined in src/pools/abstract-pool.ts:801
Protected destroyWorkerNode
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:641
+
Defined in src/pools/abstract-pool.ts:745
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1500
+
Defined in src/pools/abstract-pool.ts:1416
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1458
+
Defined in src/pools/abstract-pool.ts:703
+
Defined in src/pools/cluster/fixed.ts:58
+
Defined in src/pools/abstract-pool.ts:724
Protected registerWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:101
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:811
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:653
+
Defined in src/pools/abstract-pool.ts:608
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:627
+
Defined in src/pools/cluster/fixed.ts:53
+
Defined in src/pools/abstract-pool.ts:1328
@@ -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
@@ -172,7 +172,7 @@
+
Defined in src/pools/abstract-pool.ts:115
Protected Optional Readonly max
max?: number
@@ -181,7 +181,7 @@
+
Defined in src/pools/abstract-pool.ts:91
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -190,7 +190,7 @@
+
Defined in src/pools/abstract-pool.ts:114
Protected Readonly opts
@@ -199,7 +199,7 @@
+
Defined in src/pools/thread/fixed.ts:49
Protected promiseResponseMap
@@ -213,7 +213,7 @@
+
Defined in src/pools/abstract-pool.ts:76
Protected workerChoiceStrategyContext
@@ -222,7 +222,7 @@
+
Defined in src/pools/abstract-pool.ts:82
Readonly Internal workerNodes
@@ -231,7 +231,7 @@
+
Defined in src/pools/abstract-pool.ts:63
+
Defined in src/pools/abstract-pool.ts:687
+
Defined in src/pools/abstract-pool.ts:348
+
Defined in src/pools/abstract-pool.ts:560
+
Defined in src/pools/abstract-pool.ts:553
+
Defined in src/pools/abstract-pool.ts:505
+
Defined in src/pools/thread/fixed.ts:125
+
Defined in src/pools/abstract-pool.ts:522
+
Defined in src/pools/thread/fixed.ts:130
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1160
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:856
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:185
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1103
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1059
+
Defined in src/pools/thread/fixed.ts:117
+
Defined in src/pools/abstract-pool.ts:801
Protected destroyWorkerNode
+
Defined in src/pools/thread/fixed.ts:60
+
Defined in src/pools/abstract-pool.ts:641
+
Defined in src/pools/abstract-pool.ts:745
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1500
+
Defined in src/pools/abstract-pool.ts:1416
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1458
+
Defined in src/pools/abstract-pool.ts:703
+
Defined in src/pools/thread/fixed.ts:55
+
Defined in src/pools/abstract-pool.ts:724
Protected registerWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:107
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:811
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:653
+
Defined in src/pools/abstract-pool.ts:608
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:627
+
Defined in src/pools/abstract-pool.ts:840
+
Defined in src/pools/abstract-pool.ts:1328
@@ -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
@@ -126,7 +126,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:40
Protected Readonly isMain
isMain: boolean
@@ -146,7 +146,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:85
Protected lastTaskTimestamp
lastTaskTimestamp: number
@@ -155,7 +155,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:65
Protected opts
@@ -164,7 +164,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:88
Private port
port: MessagePort
@@ -172,7 +172,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:33
Protected statistics
@@ -181,7 +181,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:69
Protected taskFunctions
@@ -190,7 +190,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:61
Accessors
@@ -204,7 +204,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:86
Methods
@@ -237,7 +237,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
@@ -136,7 +136,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
@@ -213,7 +213,7 @@
Returns void
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:213
setWorkerChoiceStrategy
@@ -231,7 +231,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:57
-
poolifier - v2.6.38
+
poolifier - v2.6.39
Index
@@ -109,7 +109,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)
@@ -128,7 +128,7 @@
Returns void
+Defined in src/pools/pool.ts:266
Readonly execute
execute: ((data?, name?, transferList?) => Promise<Response>)
@@ -160,7 +160,7 @@
+Defined in src/pools/pool.ts:227
Readonly hasWorkerNodeBackPressure
hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
@@ -184,7 +184,7 @@
+Defined in src/pools/pool.ts:204
Readonly info
@@ -192,7 +192,7 @@
+Defined in src/pools/pool.ts:190
Readonly listTaskFunctions
listTaskFunctions: (() => string[])
@@ -209,7 +209,7 @@
+Defined in src/pools/pool.ts:241
Readonly setTasksQueueOptions
setTasksQueueOptions: ((tasksQueueOptions) => void)
@@ -232,7 +232,7 @@
Returns void
+Defined in src/pools/pool.ts:275
Readonly setWorkerChoiceStrategy
setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
@@ -259,7 +259,7 @@
Returns void
+Defined in src/pools/pool.ts:248
Readonly setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
@@ -282,7 +282,7 @@
Returns void
+Defined in src/pools/pool.ts:257
Readonly Internal workerNodes
@@ -290,7 +290,7 @@
+Defined in src/pools/pool.ts:196
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:177
+
Defined in src/pools/worker.ts:181
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:189
Readonly once
once: ((event, handler) => void)
@@ -145,12 +145,12 @@
Returns void
+Defined in src/pools/worker.ts:199
Optional Readonly threadId
threadId?: number
+Defined in src/pools/worker.ts:182
@@ -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)
@@ -83,7 +83,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)
@@ -100,7 +100,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)
@@ -123,7 +123,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
@@ -131,7 +131,7 @@ If the worker node is not eligible, undefined is returned.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:172
Readonly taskStatisticsRequirements
@@ -139,7 +139,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)
@@ -161,7 +161,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:217
@@ -80,7 +80,7 @@
Returns void
+
Defined in src/pools/worker.ts:282
Readonly closeChannel
closeChannel: (() => void)
@@ -96,7 +96,7 @@
Returns void
+Defined in src/pools/worker.ts:296
Readonly dequeueTask
dequeueTask: (() => undefined | Task<Data>)
@@ -113,7 +113,7 @@
+Defined in src/pools/worker.ts:272
Readonly enqueueTask
enqueueTask: ((task) => number)
@@ -137,7 +137,7 @@
+Defined in src/pools/worker.ts:259
Readonly getTaskFunctionWorkerUsage
getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
@@ -161,7 +161,7 @@
+Defined in src/pools/worker.ts:303
Readonly hasBackPressure
hasBackPressure: (() => boolean)
@@ -178,7 +178,7 @@
+Defined in src/pools/worker.ts:288
Readonly info
@@ -186,7 +186,7 @@
+Defined in src/pools/worker.ts:225
Optional Readonly messageChannel
messageChannel?: MessageChannel
@@ -194,7 +194,7 @@
+Defined in src/pools/worker.ts:233
Optional onBackPressure
@@ -202,7 +202,7 @@
+Defined in src/pools/worker.ts:242
Optional onEmptyQueue
@@ -210,7 +210,7 @@
+Defined in src/pools/worker.ts:246
Readonly popTask
popTask: (() => undefined | Task<Data>)
@@ -227,7 +227,7 @@
+Defined in src/pools/worker.ts:278
Readonly resetUsage
resetUsage: (() => void)
@@ -243,7 +243,7 @@
Returns void
+Defined in src/pools/worker.ts:292
tasksQueueBackPressureSize
tasksQueueBackPressureSize: number
@@ -252,7 +252,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 tasksQueueSize
tasksQueueSize: (() => number)
@@ -269,7 +269,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 unshiftTask
unshiftTask: ((task) => number)
@@ -293,7 +293,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 usage
@@ -301,7 +301,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:229
Readonly worker
worker: Worker
@@ -309,7 +309,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:221
+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
+
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
@@ -35,7 +35,7 @@
Returns void
+Defined in src/pools/worker.ts:208
+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