From 0bb3df76aeab8a2af9e99ccf91d9e9cc5e751674 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Thu, 24 Aug 2023 09:54:13 +0000
Subject: [PATCH] chore: generate documentation
---
docs/classes/AbstractPool.html | 174 +++++++++---------
docs/classes/AbstractWorker.html | 80 ++++----
docs/classes/CircularArray.html | 28 +--
docs/classes/ClusterWorker.html | 54 +++---
docs/classes/Deque.html | 38 ++--
docs/classes/DynamicClusterPool.html | 96 +++++-----
docs/classes/DynamicThreadPool.html | 96 +++++-----
docs/classes/FixedClusterPool.html | 96 +++++-----
docs/classes/FixedThreadPool.html | 96 +++++-----
docs/classes/PoolEmitter.html | 8 +-
docs/classes/ThreadWorker.html | 56 +++---
docs/classes/WorkerChoiceStrategyContext.html | 32 ++--
docs/functions/availableParallelism.html | 8 +-
docs/index.html | 8 +-
docs/interfaces/ClusterPoolOptions.html | 32 ++--
...tLoopUtilizationMeasurementStatistics.html | 14 +-
docs/interfaces/IPool.html | 30 +--
docs/interfaces/IWorker.html | 16 +-
docs/interfaces/IWorkerChoiceStrategy.html | 22 +--
docs/interfaces/IWorkerNode.html | 42 ++---
docs/interfaces/MeasurementOptions.html | 10 +-
docs/interfaces/MeasurementStatistics.html | 20 +-
.../MeasurementStatisticsRequirements.html | 14 +-
docs/interfaces/MessageValue.html | 36 ++--
docs/interfaces/PoolInfo.html | 46 ++---
docs/interfaces/PoolOptions.html | 28 +--
docs/interfaces/PromiseResponseWrapper.html | 14 +-
docs/interfaces/StrategyPolicy.html | 12 +-
docs/interfaces/Task.html | 20 +-
docs/interfaces/TaskError.html | 14 +-
docs/interfaces/TaskPerformance.html | 16 +-
docs/interfaces/TaskStatistics.html | 18 +-
.../TaskStatisticsRequirements.html | 14 +-
docs/interfaces/TasksQueueOptions.html | 14 +-
docs/interfaces/ThreadPoolOptions.html | 30 +--
.../WorkerChoiceStrategyOptions.html | 20 +-
docs/interfaces/WorkerInfo.html | 18 +-
docs/interfaces/WorkerOptions.html | 16 +-
docs/interfaces/WorkerStatistics.html | 12 +-
docs/interfaces/WorkerUsage.html | 16 +-
docs/types/ErrorHandler.html | 8 +-
docs/types/ExitHandler.html | 8 +-
docs/types/KillBehavior.html | 8 +-
docs/types/KillHandler.html | 8 +-
docs/types/Measurement.html | 8 +-
docs/types/MessageHandler.html | 8 +-
docs/types/OnlineHandler.html | 8 +-
docs/types/PoolEvent.html | 8 +-
docs/types/PoolType.html | 8 +-
docs/types/TaskAsyncFunction.html | 8 +-
docs/types/TaskFunction.html | 8 +-
docs/types/TaskFunctions.html | 8 +-
docs/types/TaskSyncFunction.html | 8 +-
docs/types/WorkerChoiceStrategy.html | 8 +-
docs/types/WorkerType.html | 8 +-
docs/types/Writable.html | 8 +-
docs/variables/KillBehaviors.html | 8 +-
docs/variables/Measurements.html | 8 +-
docs/variables/PoolEvents.html | 8 +-
docs/variables/PoolTypes.html | 8 +-
docs/variables/WorkerChoiceStrategies.html | 8 +-
docs/variables/WorkerTypes.html | 8 +-
62 files changed, 795 insertions(+), 795 deletions(-)
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 00d68b3d1..afe2c6221 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-AbstractPool | poolifier - v2.6.33
+AbstractPool | poolifier - v2.6.34
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:57
@@ -189,7 +189,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:113
Protected Readonly filePath
filePath: string
@@ -218,7 +218,7 @@
+
Defined in src/pools/abstract-pool.ts:115
Protected Optional Readonly max
max?: number
@@ -226,7 +226,7 @@
+Defined in src/pools/abstract-pool.ts:91
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -234,7 +234,7 @@
+Defined in src/pools/abstract-pool.ts:114
Protected Readonly opts
@@ -242,7 +242,7 @@
+Defined in src/pools/abstract-pool.ts:116
Protected promiseResponseMap
@@ -255,7 +255,7 @@
+Defined in src/pools/abstract-pool.ts:76
Private Readonly startTimestamp
startTimestamp: number
@@ -263,7 +263,7 @@
+Defined in src/pools/abstract-pool.ts:104
Private started
started: boolean
@@ -271,7 +271,7 @@
+Defined in src/pools/abstract-pool.ts:100
Private Readonly starting
starting: boolean
@@ -279,7 +279,7 @@
+Defined in src/pools/abstract-pool.ts:96
Protected workerChoiceStrategyContext
@@ -287,7 +287,7 @@
+Defined in src/pools/abstract-pool.ts:82
Readonly Internal workerNodes
@@ -296,7 +296,7 @@
+Defined in src/pools/abstract-pool.ts:63
Protected full
@@ -322,7 +322,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:682
+Defined in src/pools/abstract-pool.ts:354
Protected maxSize
@@ -345,7 +345,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:555
Protected minSize
@@ -356,7 +356,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:548
Private ready
@@ -367,7 +367,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:500
Protected Abstract type
@@ -379,7 +379,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:538
+Defined in src/pools/abstract-pool.ts:517
Protected Abstract worker
@@ -402,7 +402,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:543
Protected afterTaskExecutionHook
@@ -451,7 +451,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:879
Protected afterWorkerNodeSetup
@@ -471,7 +471,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1151
Protected beforeTaskExecutionHook
@@ -496,7 +496,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:849
Private buildTasksQueueOptions
@@ -509,7 +509,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:665
Private checkAndEmitDynamicWorkerCreationEvents
@@ -517,7 +517,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1376
Private checkAndEmitTaskExecutionEvents
@@ -525,7 +525,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1364
Private checkAndEmitTaskQueuingEvents
@@ -533,7 +533,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1370
Protected checkDynamicPoolSize
@@ -548,7 +548,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:185
Private checkFilePath
@@ -561,7 +561,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:565
Private checkNumberOfWorkers
@@ -595,7 +595,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:167
Private checkPoolOptions
@@ -608,7 +608,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:211
Private checkValidTasksQueueOptions
@@ -621,7 +621,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:293
Private checkValidWorkerChoiceStrategy
@@ -634,7 +634,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
@@ -647,7 +647,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:249
Private chooseWorkerNode
@@ -660,7 +660,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1004
Protected createAndSetupDynamicWorkerNode
@@ -672,7 +672,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1094
Protected createAndSetupWorkerNode
@@ -684,7 +684,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1050
Protected Abstract createWorker
@@ -696,7 +696,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1043
Private dequeueTask
@@ -709,7 +709,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1467
+Defined in src/pools/abstract-pool.ts:794
Protected Abstract destroyWorkerNode
@@ -740,7 +740,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:825
+Defined in src/pools/abstract-pool.ts:636
Private enqueueTask
@@ -780,7 +780,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1461
+Defined in src/pools/abstract-pool.ts:732
Private executeTask
@@ -835,7 +835,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1455
Protected flushTasksQueue
@@ -848,7 +848,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1475
Private flushTasksQueues
@@ -856,7 +856,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1485
Protected getWorkerInfo
@@ -876,7 +876,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1390
Private getWorkerNodeKeyByWorker
@@ -896,7 +896,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:584
Private getWorkerNodeKeyByWorkerId
@@ -916,7 +916,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:596
Private handleTaskExecutionResponse
@@ -929,7 +929,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1336
Private handleWorkerReadyResponse
@@ -942,7 +942,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1322
Private hasBackPressure
@@ -950,7 +950,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1440
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1433
Protected internalBusy
@@ -983,7 +983,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:698
Protected Abstract isMain
@@ -994,7 +994,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:840
+Defined in src/pools/abstract-pool.ts:719
Private redistributeQueuedTasks
@@ -1020,7 +1020,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1191
Protected Abstract registerWorkerMessageListener
@@ -1060,7 +1060,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1138
Private removeWorkerNode
@@ -1079,7 +1079,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1424
Protected sendKillMessageToWorker
@@ -1094,7 +1094,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:804
Protected Abstract sendStartupMessageToWorker
@@ -1113,7 +1113,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1171
Private sendStatisticsMessageToWorker
@@ -1132,7 +1132,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1178
Protected Abstract sendToWorker
@@ -1161,7 +1161,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1032
Private setTasksQueueMaxSize
@@ -1174,7 +1174,7 @@ Can be overridden.
size: number
Returns void
+Defined in src/pools/abstract-pool.ts:659
+Defined in src/pools/abstract-pool.ts:648
+Defined in src/pools/abstract-pool.ts:603
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:622
Protected setupHook
@@ -1251,7 +1251,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:833
Private shallCreateDynamicWorker
@@ -1263,7 +1263,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1021
Private shallUpdateTaskFunctionWorkerUsage
@@ -1283,7 +1283,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:912
Private startPool
@@ -1291,7 +1291,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:341
Private taskStealingOnEmptyQueue
@@ -1304,7 +1304,7 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1229
Private tasksQueueSize
@@ -1317,7 +1317,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1471
Private tasksStealingOnBackPressure
@@ -1330,7 +1330,7 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1264
Private updateEluWorkerUsage
@@ -1345,7 +1345,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:965
Private updateRunTimeWorkerUsage
@@ -1360,7 +1360,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:939
Private updateTaskStatisticsWorkerUsage
@@ -1375,7 +1375,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:921
Private updateWaitTimeWorkerUsage
@@ -1390,7 +1390,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:951
Protected workerListener
@@ -1417,7 +1417,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1302
+
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:568
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:409
Private checkMessageWorkerId
+Defined in src/worker/abstract-worker.ts:375
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:592
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:298
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:108
Private checkWorkerOptions
@@ -390,7 +390,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:98
emitDestroy
@@ -419,7 +419,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:577
Protected getMainWorker
@@ -431,7 +431,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:423
+Defined in src/worker/abstract-worker.ts:559
Protected handleError
@@ -473,7 +473,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:455
Protected handleKillMessage
@@ -492,7 +492,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:341
Protected Abstract handleReadyMessage
@@ -511,7 +511,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:312
+Defined in src/worker/abstract-worker.ts:167
listTaskFunctions
@@ -545,7 +545,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:245
Protected messageListener
@@ -564,7 +564,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:319
+Defined in src/worker/abstract-worker.ts:221
+Defined in src/worker/abstract-worker.ts:465
Protected runAsync
@@ -635,7 +635,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:517
runInAsyncScope
@@ -714,7 +714,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:480
Protected sendTaskFunctionsListToMainWorker
@@ -725,7 +725,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:442
Protected Abstract sendToMainWorker
@@ -744,7 +744,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:435
+Defined in src/worker/abstract-worker.ts:275
Private startCheckActive
@@ -781,7 +781,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:388
Private stopCheckActive
@@ -792,7 +792,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:399
triggerAsyncId
@@ -811,7 +811,7 @@ then restore the original execution context.
-
Returns void
+Defined in src/worker/abstract-worker.ts:598
Static bind
@@ -31,7 +31,7 @@
+
Defined in src/circular-array.ts:8
+
Defined in src/circular-array.ts:11
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:9
Static Readonly [species]
[species]: ArrayConstructor
Returns void
+
Defined in src/circular-array.ts:98
concat
@@ -222,7 +222,7 @@ when they will be absent when used in a 'with' statement.
Inherit Doc
+Defined in src/circular-array.ts:39
copyWithin
@@ -263,7 +263,7 @@ is treated as length+end. If start is omitted, 0 is used.
-
Returns boolean
+Defined in src/circular-array.ts:90
entries
@@ -729,7 +729,7 @@ thisArg is omitted, undefined is used as the this value.
-
Returns boolean
+Defined in src/circular-array.ts:94
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:21
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:78
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:54
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:30
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:183
+
Defined in src/worker/abstract-worker.ts:423
+
Defined in src/worker/abstract-worker.ts:455
Protected handleKillMessage
+
Defined in src/worker/abstract-worker.ts:341
Protected handleReadyMessage
+
Defined in src/worker/cluster-worker.ts:45
hasTaskFunction
@@ -383,7 +383,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:167
+Defined in src/worker/abstract-worker.ts:245
Protected messageListener
+Defined in src/worker/abstract-worker.ts:319
+Defined in src/worker/abstract-worker.ts:221
+Defined in src/worker/abstract-worker.ts:465
+Defined in src/worker/abstract-worker.ts:517
+Defined in src/worker/abstract-worker.ts:480
Protected sendTaskFunctionsListToMainWorker
+Defined in src/worker/abstract-worker.ts:442
Protected sendToMainWorker
+Defined in src/worker/cluster-worker.ts:70
+Defined in src/worker/abstract-worker.ts:275
triggerAsyncId
@@ -33,7 +33,7 @@ Implemented with a doubly linked list.
+
Defined in src/deque.ts:19
@@ -77,14 +77,14 @@ Implemented with a doubly linked list.
T
Returns Deque<T>
+
Defined in src/deque.ts:27
Properties
Private Optional head
head?: Node<T>
+Defined in src/deque.ts:20
maxSize
maxSize: number
@@ -92,7 +92,7 @@ Implemented with a doubly linked list.
+
Defined in src/deque.ts:25
size
size: number
@@ -100,12 +100,12 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:23
Private Optional tail
tail?: Node<T>
+Defined in src/deque.ts:21
+Defined in src/deque.ts:163
clear
@@ -146,7 +146,7 @@ Implemented with a doubly linked list.
Returns void
+Defined in src/deque.ts:124
Private incrementSize
@@ -154,7 +154,7 @@ Implemented with a doubly linked list.
-
Returns number
+Defined in src/deque.ts:187
peekFirst
@@ -166,7 +166,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:109
peekLast
@@ -178,7 +178,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:117
pop
@@ -190,7 +190,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:70
push
@@ -210,7 +210,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:37
shift
@@ -222,7 +222,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:90
unshift
@@ -242,7 +242,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:54
@@ -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:66
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:115
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:114
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:76
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:82
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:63
+
Defined in src/pools/abstract-pool.ts:682
+
Defined in src/pools/abstract-pool.ts:354
+
Defined in src/pools/abstract-pool.ts:555
+
Defined in src/pools/abstract-pool.ts:548
+
Defined in src/pools/abstract-pool.ts:500
+
Defined in src/pools/cluster/dynamic.ts:38
+
Defined in src/pools/abstract-pool.ts:517
+
Defined in src/pools/cluster/fixed.ts:115
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1151
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:849
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:185
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1094
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1050
+
Defined in src/pools/cluster/fixed.ts:105
+
Defined in src/pools/abstract-pool.ts:794
Protected destroyWorkerNode
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:636
+
Defined in src/pools/abstract-pool.ts:732
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1475
+
Defined in src/pools/abstract-pool.ts:1390
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1433
+
Defined in src/pools/abstract-pool.ts:698
+
Defined in src/pools/cluster/fixed.ts:58
+
Defined in src/pools/abstract-pool.ts:719
Protected registerWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:97
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:804
Protected sendStartupMessageToWorker
+
Defined in src/pools/cluster/fixed.ts:89
+
Defined in src/pools/cluster/fixed.ts:81
+
Defined in src/pools/abstract-pool.ts:648
+
Defined in src/pools/abstract-pool.ts:603
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:622
+
Defined in src/pools/cluster/fixed.ts:53
+
Defined in src/pools/abstract-pool.ts:1302
@@ -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:66
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:115
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:114
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:76
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:82
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:63
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:682
+
Defined in src/pools/abstract-pool.ts:354
+
Defined in src/pools/abstract-pool.ts:555
+
Defined in src/pools/abstract-pool.ts:548
+
Defined in src/pools/abstract-pool.ts:500
+
Defined in src/pools/thread/dynamic.ts:38
+
Defined in src/pools/abstract-pool.ts:517
+
Defined in src/pools/thread/fixed.ts:127
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1151
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:849
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:185
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1094
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1050
+
Defined in src/pools/thread/fixed.ts:114
+
Defined in src/pools/abstract-pool.ts:794
Protected destroyWorkerNode
+
Defined in src/pools/thread/fixed.ts:60
+
Defined in src/pools/abstract-pool.ts:636
+
Defined in src/pools/abstract-pool.ts:732
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1475
+
Defined in src/pools/abstract-pool.ts:1390
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1433
+
Defined in src/pools/abstract-pool.ts:698
+
Defined in src/pools/thread/fixed.ts:55
+
Defined in src/pools/abstract-pool.ts:719
Protected registerWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:104
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:804
Protected sendStartupMessageToWorker
+
Defined in src/pools/thread/fixed.ts:88
+
Defined in src/pools/thread/fixed.ts:77
+
Defined in src/pools/abstract-pool.ts:648
+
Defined in src/pools/abstract-pool.ts:603
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:622
+
Defined in src/pools/abstract-pool.ts:833
+
Defined in src/pools/abstract-pool.ts:1302
@@ -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:115
Protected Optional Readonly max
max?: number
@@ -184,7 +184,7 @@
+
Defined in src/pools/abstract-pool.ts:91
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -193,7 +193,7 @@
+
Defined in src/pools/abstract-pool.ts:114
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:76
Protected workerChoiceStrategyContext
@@ -225,7 +225,7 @@
+
Defined in src/pools/abstract-pool.ts:82
Readonly Internal workerNodes
@@ -234,7 +234,7 @@
+
Defined in src/pools/abstract-pool.ts:63
+
Defined in src/pools/abstract-pool.ts:682
+
Defined in src/pools/abstract-pool.ts:354
+
Defined in src/pools/abstract-pool.ts:555
+
Defined in src/pools/abstract-pool.ts:548
+
Defined in src/pools/abstract-pool.ts:500
+
Defined in src/pools/cluster/fixed.ts:110
+
Defined in src/pools/abstract-pool.ts:517
+
Defined in src/pools/cluster/fixed.ts:115
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1151
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:849
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:185
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1094
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1050
+
Defined in src/pools/cluster/fixed.ts:105
+
Defined in src/pools/abstract-pool.ts:794
Protected destroyWorkerNode
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:636
+
Defined in src/pools/abstract-pool.ts:732
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1475
+
Defined in src/pools/abstract-pool.ts:1390
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1433
+
Defined in src/pools/abstract-pool.ts:698
+
Defined in src/pools/cluster/fixed.ts:58
+
Defined in src/pools/abstract-pool.ts:719
Protected registerWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:97
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:804
Protected sendStartupMessageToWorker
+
Defined in src/pools/cluster/fixed.ts:89
+
Defined in src/pools/cluster/fixed.ts:81
+
Defined in src/pools/abstract-pool.ts:648
+
Defined in src/pools/abstract-pool.ts:603
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:622
+
Defined in src/pools/cluster/fixed.ts:53
+
Defined in src/pools/abstract-pool.ts:1302
@@ -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:115
Protected Optional Readonly max
max?: number
@@ -184,7 +184,7 @@
+
Defined in src/pools/abstract-pool.ts:91
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -193,7 +193,7 @@
+
Defined in src/pools/abstract-pool.ts:114
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:76
Protected workerChoiceStrategyContext
@@ -225,7 +225,7 @@
+
Defined in src/pools/abstract-pool.ts:82
Readonly Internal workerNodes
@@ -234,7 +234,7 @@
+
Defined in src/pools/abstract-pool.ts:63
+
Defined in src/pools/abstract-pool.ts:682
+
Defined in src/pools/abstract-pool.ts:354
+
Defined in src/pools/abstract-pool.ts:555
+
Defined in src/pools/abstract-pool.ts:548
+
Defined in src/pools/abstract-pool.ts:500
+
Defined in src/pools/thread/fixed.ts:122
+
Defined in src/pools/abstract-pool.ts:517
+
Defined in src/pools/thread/fixed.ts:127
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1151
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:849
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:185
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1094
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1050
+
Defined in src/pools/thread/fixed.ts:114
+
Defined in src/pools/abstract-pool.ts:794
Protected destroyWorkerNode
+
Defined in src/pools/thread/fixed.ts:60
+
Defined in src/pools/abstract-pool.ts:636
+
Defined in src/pools/abstract-pool.ts:732
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1475
+
Defined in src/pools/abstract-pool.ts:1390
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1433
+
Defined in src/pools/abstract-pool.ts:698
+
Defined in src/pools/thread/fixed.ts:55
+
Defined in src/pools/abstract-pool.ts:719
Protected registerWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:104
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:804
Protected sendStartupMessageToWorker
+
Defined in src/pools/thread/fixed.ts:88
+
Defined in src/pools/thread/fixed.ts:77
+
Defined in src/pools/abstract-pool.ts:648
+
Defined in src/pools/abstract-pool.ts:603
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:622
+
Defined in src/pools/abstract-pool.ts:833
+
Defined in src/pools/abstract-pool.ts:1302
@@ -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:183
+Defined in src/worker/abstract-worker.ts:423
+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:167
+Defined in src/worker/abstract-worker.ts:245
Protected messageListener
+Defined in src/worker/abstract-worker.ts:319
+Defined in src/worker/abstract-worker.ts:221
+Defined in src/worker/abstract-worker.ts:465
+Defined in src/worker/abstract-worker.ts:517
+Defined in src/worker/abstract-worker.ts:480
Protected sendTaskFunctionsListToMainWorker
+Defined in src/worker/abstract-worker.ts:442
Protected sendToMainWorker
+Defined in src/worker/thread-worker.ts:91
+Defined in src/worker/abstract-worker.ts:275
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:52
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:48
-
poolifier - v2.6.33
+
poolifier - v2.6.34
Index
@@ -107,7 +107,7 @@
Theme
@@ -26,7 +26,7 @@
+
Defined in src/pools/cluster/fixed.ts:10
+
Defined in src/pools/pool.ts:161
Optional enableTasksQueue
enableTasksQueue?: boolean
@@ -70,7 +70,7 @@
+Defined in src/pools/pool.ts:167
+Defined in src/pools/cluster/fixed.ts:16
Optional errorHandler
@@ -89,7 +89,7 @@
+Defined in src/pools/pool.ts:137
Optional exitHandler
@@ -98,7 +98,7 @@
+Defined in src/pools/pool.ts:141
Optional messageHandler
@@ -107,7 +107,7 @@
+Defined in src/pools/pool.ts:133
Optional onlineHandler
@@ -116,7 +116,7 @@
+Defined in src/pools/pool.ts:129
Optional restartWorkerOnError
restartWorkerOnError?: boolean
@@ -125,7 +125,7 @@
+Defined in src/pools/pool.ts:155
+Defined in src/pools/cluster/fixed.ts:22
Optional tasksQueueOptions
@@ -144,7 +144,7 @@
+Defined in src/pools/pool.ts:171
Optional workerChoiceStrategy
workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -155,7 +155,7 @@
+Defined in src/pools/pool.ts:147
Optional workerChoiceStrategyOptions
@@ -164,7 +164,7 @@
+Defined in src/pools/pool.ts:151
@@ -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:181
@@ -83,7 +83,7 @@
Returns Promise<void>
+
Defined in src/pools/pool.ts:234
Optional Readonly emitter
@@ -101,7 +101,7 @@
+Defined in src/pools/pool.ts:217
Readonly enableTasksQueue
enableTasksQueue: ((enable, tasksQueueOptions?) => void)
@@ -130,7 +130,7 @@
Returns void
+Defined in src/pools/pool.ts:265
Readonly execute
execute: ((data?, name?, transferList?) => Promise<Response>)
@@ -165,7 +165,7 @@
+Defined in src/pools/pool.ts:226
Readonly hasWorkerNodeBackPressure
hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
@@ -190,7 +190,7 @@
+Defined in src/pools/pool.ts:203
Readonly info
@@ -198,7 +198,7 @@
+Defined in src/pools/pool.ts:189
Readonly listTaskFunctions
listTaskFunctions: (() => string[])
@@ -215,7 +215,7 @@
+Defined in src/pools/pool.ts:240
Readonly setTasksQueueOptions
setTasksQueueOptions: ((tasksQueueOptions) => void)
@@ -239,7 +239,7 @@
Returns void
+Defined in src/pools/pool.ts:274
Readonly setWorkerChoiceStrategy
setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
@@ -268,7 +268,7 @@
Returns void
+Defined in src/pools/pool.ts:247
Readonly setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
@@ -292,7 +292,7 @@
Returns void
+Defined in src/pools/pool.ts:256
Readonly Internal workerNodes
@@ -300,7 +300,7 @@
+Defined in src/pools/pool.ts:195
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:173
+
Defined in src/pools/worker.ts:177
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:185
Readonly once
once: ((event, handler) => void)
@@ -147,12 +147,12 @@
Returns void
+Defined in src/pools/worker.ts:195
Optional Readonly threadId
threadId?: number
+Defined in src/pools/worker.ts:178
@@ -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:205
@@ -80,7 +80,7 @@
Returns void
+
Defined in src/pools/worker.ts:274
Readonly closeChannel
closeChannel: (() => void)
@@ -96,7 +96,7 @@
Returns void
+Defined in src/pools/worker.ts:288
Readonly dequeueTask
dequeueTask: (() => undefined | Task<Data>)
@@ -113,7 +113,7 @@
+Defined in src/pools/worker.ts:264
Readonly enqueueTask
enqueueTask: ((task) => number)
@@ -138,7 +138,7 @@
+Defined in src/pools/worker.ts:251
Readonly getTaskFunctionWorkerUsage
getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
@@ -163,7 +163,7 @@
+Defined in src/pools/worker.ts:295
Readonly hasBackPressure
hasBackPressure: (() => boolean)
@@ -180,7 +180,7 @@
+Defined in src/pools/worker.ts:280
Readonly info
@@ -188,7 +188,7 @@
+Defined in src/pools/worker.ts:213
Optional Readonly messageChannel
messageChannel?: MessageChannel
@@ -196,7 +196,7 @@
+Defined in src/pools/worker.ts:217
Optional onBackPressure
onBackPressure?: ((workerId) => void)
@@ -220,7 +220,7 @@
Returns void
+Defined in src/pools/worker.ts:232
Optional onEmptyQueue
onEmptyQueue?: ((workerId) => void)
@@ -244,7 +244,7 @@
Returns void
+Defined in src/pools/worker.ts:238
Readonly popTask
popTask: (() => undefined | Task<Data>)
@@ -261,7 +261,7 @@
+Defined in src/pools/worker.ts:270
Readonly resetUsage
resetUsage: (() => void)
@@ -277,7 +277,7 @@
Returns void
+Defined in src/pools/worker.ts:284
tasksQueueBackPressureSize
tasksQueueBackPressureSize: number
@@ -286,7 +286,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:226
Readonly tasksQueueSize
tasksQueueSize: (() => number)
@@ -303,7 +303,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:244
Readonly unshiftTask
unshiftTask: ((task) => number)
@@ -328,7 +328,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:258
usage
@@ -336,7 +336,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:221
Readonly worker
worker: Worker
@@ -344,7 +344,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:209
+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:99
+
Defined in src/utility-types.ts:128
Optional Readonly data
data?: Data
@@ -80,7 +80,7 @@
+
Defined in src/utility-types.ts:77
Optional Readonly kill
kill?: true | "success" | "SOFT" | "HARD" | "failure"
@@ -88,7 +88,7 @@
+Defined in src/utility-types.ts:104
Optional Readonly name
name?: string
@@ -97,7 +97,7 @@
+Defined in src/utility-types.ts:73
Optional Readonly port
port?: MessagePort
@@ -105,7 +105,7 @@
+Defined in src/utility-types.ts:132
Optional Readonly ready
ready?: boolean
@@ -113,7 +113,7 @@
+Defined in src/utility-types.ts:124
Optional Readonly statistics
@@ -121,7 +121,7 @@
+Defined in src/utility-types.ts:120
Optional Readonly taskError
@@ -129,7 +129,7 @@
+Defined in src/utility-types.ts:108
Optional Readonly taskFunctions
taskFunctions?: string[]
@@ -137,7 +137,7 @@
+Defined in src/utility-types.ts:116
Optional Readonly taskId
taskId?: string
@@ -146,7 +146,7 @@
+Defined in src/utility-types.ts:89
Optional Readonly taskPerformance
@@ -154,7 +154,7 @@
+Defined in src/utility-types.ts:112
Optional Readonly timestamp
timestamp?: number
@@ -163,7 +163,7 @@
+Defined in src/utility-types.ts:85
Optional Readonly transferList
transferList?: TransferListItem[]
@@ -172,7 +172,7 @@
+Defined in src/utility-types.ts:81
Readonly workerId
workerId: number
@@ -181,7 +181,7 @@
+Defined in src/utility-types.ts:69
@@ -24,7 +24,7 @@
+
Defined in src/pools/pool.ts:62
@@ -58,7 +58,7 @@
Optional Readonly backPressure
backPressure?: boolean
Readonly busyWorkerNodes
busyWorkerNodes: number
@@ -66,22 +66,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:83
Readonly idleWorkerNodes
idleWorkerNodes: number
@@ -89,32 +89,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;
}
@@ -130,17 +130,17 @@
Readonly minimum: number
+Defined in src/pools/pool.ts:84
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
@@ -148,12 +148,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;
}
@@ -169,12 +169,12 @@
Readonly minimum: number
+Defined in src/pools/pool.ts:90
Readonly worker
worker: "thread" | "cluster"
+Defined in src/pools/pool.ts:65
Readonly workerNodes
workerNodes: number
@@ -182,7 +182,7 @@
+Defined in src/pools/pool.ts:73
@@ -35,7 +35,7 @@
ClusterPoolOptions
ThreadPoolOptions
+
Defined in src/pools/pool.ts:125
@@ -65,7 +65,7 @@
Default Value
true
+
Defined in src/pools/pool.ts:161
Optional enableTasksQueue
enableTasksQueue?: boolean
@@ -75,7 +75,7 @@
Default Value
false
+Defined in src/pools/pool.ts:167
Optional errorHandler
@@ -83,7 +83,7 @@
+Defined in src/pools/pool.ts:137
Optional exitHandler
@@ -91,7 +91,7 @@
+Defined in src/pools/pool.ts:141
Optional messageHandler
@@ -99,7 +99,7 @@
+Defined in src/pools/pool.ts:133
Optional onlineHandler
@@ -107,7 +107,7 @@
+Defined in src/pools/pool.ts:129
Optional restartWorkerOnError
restartWorkerOnError?: boolean
@@ -115,7 +115,7 @@
+Defined in src/pools/pool.ts:155
Optional tasksQueueOptions
@@ -123,7 +123,7 @@
+Defined in src/pools/pool.ts:171
Optional workerChoiceStrategy
workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -133,7 +133,7 @@
Default Value
WorkerChoiceStrategies.ROUND_ROBIN
+Defined in src/pools/pool.ts:147
Optional workerChoiceStrategyOptions
@@ -141,7 +141,7 @@
+Defined in src/pools/pool.ts:151
@@ -32,7 +32,7 @@
+
Defined in src/utility-types.ts:141
@@ -66,7 +66,7 @@
Returns void
+
Defined in src/utility-types.ts:149
Readonly resolve
resolve: ((value) => void)
@@ -87,7 +87,7 @@
Returns void
+Defined in src/utility-types.ts:145
Readonly workerNodeKey
workerNodeKey: number
@@ -95,7 +95,7 @@
+Defined in src/utility-types.ts:153
+
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:65
+
Defined in src/utility-types.ts:77
Optional Readonly name
name?: string
@@ -66,7 +66,7 @@
+Defined in src/utility-types.ts:73
Optional Readonly taskId
taskId?: string
@@ -74,7 +74,7 @@
+Defined in src/utility-types.ts:89
Optional Readonly timestamp
timestamp?: number
@@ -82,7 +82,7 @@
+Defined in src/utility-types.ts:85
Optional Readonly transferList
transferList?: TransferListItem[]
@@ -90,7 +90,7 @@
+Defined in src/utility-types.ts:81
Readonly workerId
workerId: number
@@ -98,7 +98,7 @@
+Defined in src/utility-types.ts:69
@@ -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
@@ -55,7 +55,7 @@
+Defined in src/pools/worker.ts:90
failed
failed: number
@@ -63,7 +63,7 @@
+Defined in src/pools/worker.ts:102
Optional Readonly maxQueued
maxQueued?: number
@@ -71,7 +71,7 @@
+Defined in src/pools/worker.ts:98
Readonly queued
queued: number
@@ -79,7 +79,7 @@
+Defined in src/pools/worker.ts:94
+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:101
@@ -47,7 +47,7 @@
Default Value
1
+
Defined in src/pools/pool.ts:117
Optional Readonly queueMaxSize
queueMaxSize?: number
@@ -55,7 +55,7 @@
Deprecated
Use size instead.
+Defined in src/pools/pool.ts:111
Optional Readonly size
size?: number
@@ -65,7 +65,7 @@
Default Value
(pool maximum size)^2
+Defined in src/pools/pool.ts:107
@@ -26,7 +26,7 @@
+
Defined in src/pools/thread/fixed.ts:18
+
Defined in src/pools/pool.ts:161
Optional enableTasksQueue
enableTasksQueue?: boolean
@@ -69,7 +69,7 @@
+Defined in src/pools/pool.ts:167
Optional errorHandler
@@ -78,7 +78,7 @@
+Defined in src/pools/pool.ts:137
Optional exitHandler
@@ -87,7 +87,7 @@
+Defined in src/pools/pool.ts:141
Optional messageHandler
@@ -96,7 +96,7 @@
+Defined in src/pools/pool.ts:133
Optional onlineHandler
@@ -105,7 +105,7 @@
+Defined in src/pools/pool.ts:129
Optional restartWorkerOnError
restartWorkerOnError?: boolean
@@ -114,7 +114,7 @@
+Defined in src/pools/pool.ts:155
Optional tasksQueueOptions
@@ -123,7 +123,7 @@
+Defined in src/pools/pool.ts:171
Optional workerChoiceStrategy
workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -134,7 +134,7 @@
+Defined in src/pools/pool.ts:147
Optional workerChoiceStrategyOptions
@@ -143,7 +143,7 @@
+Defined in src/pools/pool.ts:151
+Defined in src/pools/thread/fixed.ts:24
@@ -24,7 +24,7 @@
- WorkerChoiceStrategyOptions
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:69
@@ -50,7 +50,7 @@
Default Value
6
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:75
Optional Readonly elu
@@ -60,7 +60,7 @@
Default Value
{ median: false }
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:97
Optional Readonly measurement
measurement?: "runTime" | "waitTime" | "elu"
@@ -68,7 +68,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:79
Optional Readonly runTime
@@ -78,7 +78,7 @@
Default Value
{ median: false }
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:85
Optional Readonly waitTime
@@ -88,7 +88,7 @@
Default Value
{ median: false }
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:91
Optional Readonly weights
weights?: Record<number, number>
@@ -99,7 +99,7 @@ Weight is the tasks maximum average or median runtime in milliseconds.
Default Value
Computed worker weights automatically given the CPU performance.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:104
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:123
+
Defined in src/pools/worker.ts:135
Readonly id
id: undefined | number
@@ -55,7 +55,7 @@
+Defined in src/pools/worker.ts:127
ready
ready: boolean
@@ -63,7 +63,7 @@
+Defined in src/pools/worker.ts:139
Optional taskFunctions
taskFunctions?: string[]
@@ -71,7 +71,7 @@
+Defined in src/pools/worker.ts:143
type
type: "thread" | "cluster"
@@ -79,7 +79,7 @@
+Defined in src/pools/worker.ts:131
@@ -24,7 +24,7 @@
+
Defined in src/worker/worker-options.ts:28
@@ -50,7 +50,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"
@@ -65,7 +65,7 @@
Default Value
KillBehaviors.SOFT
+Defined in src/worker/worker-options.ts:39
Optional killHandler
@@ -73,7 +73,7 @@
+Defined in src/worker/worker-options.ts:56
Optional maxInactiveTime
maxInactiveTime?: number
@@ -90,7 +90,7 @@ when this timeout expires your tasks is interrupted before completion and remove
Default Value
60000
+Defined in src/worker/worker-options.ts:52
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:151
+
Defined in src/pools/worker.ts:167
Readonly runTime
@@ -54,7 +54,7 @@
+Defined in src/pools/worker.ts:159
Readonly tasks
@@ -62,7 +62,7 @@
+Defined in src/pools/worker.ts:155
Readonly waitTime
@@ -70,7 +70,7 @@
+Defined in src/pools/worker.ts:163
@@ -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
+Defined in src/pools/worker.ts:116
+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:108