From 85c03385d4a5d06c979104ae7e96d68b2301d10a Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Sat, 8 Jul 2023 23:17:14 +0000
Subject: [PATCH] chore: generate documentation
---
docs/classes/AbstractPool.html | 148 +++++++++---------
docs/classes/AbstractWorker.html | 58 +++----
docs/classes/CircularArray.html | 28 ++--
docs/classes/ClusterWorker.html | 40 ++---
docs/classes/DynamicClusterPool.html | 86 +++++-----
docs/classes/DynamicThreadPool.html | 86 +++++-----
docs/classes/FixedClusterPool.html | 84 +++++-----
docs/classes/FixedThreadPool.html | 84 +++++-----
docs/classes/PoolEmitter.html | 8 +-
docs/classes/Queue.html | 26 +--
docs/classes/ThreadWorker.html | 40 ++---
docs/classes/WorkerChoiceStrategyContext.html | 28 ++--
docs/functions/availableParallelism.html | 8 +-
docs/index.html | 8 +-
docs/interfaces/ClusterPoolOptions.html | 32 ++--
...tLoopUtilizationMeasurementStatistics.html | 14 +-
docs/interfaces/IPool.html | 28 ++--
docs/interfaces/IWorker.html | 16 +-
docs/interfaces/IWorkerChoiceStrategy.html | 22 +--
docs/interfaces/IWorkerNode.html | 24 +--
docs/interfaces/MeasurementOptions.html | 10 +-
docs/interfaces/MeasurementStatistics.html | 20 +--
.../MeasurementStatisticsRequirements.html | 14 +-
docs/interfaces/MessageValue.html | 30 ++--
docs/interfaces/PoolInfo.html | 44 +++---
docs/interfaces/PoolOptions.html | 28 ++--
docs/interfaces/PromiseResponseWrapper.html | 14 +-
docs/interfaces/StrategyPolicy.html | 10 +-
docs/interfaces/Task.html | 18 +--
docs/interfaces/TaskError.html | 12 +-
docs/interfaces/TaskPerformance.html | 14 +-
docs/interfaces/TaskStatistics.html | 18 +--
.../TaskStatisticsRequirements.html | 14 +-
docs/interfaces/TasksQueueOptions.html | 10 +-
docs/interfaces/ThreadPoolOptions.html | 30 ++--
.../WorkerChoiceStrategyOptions.html | 18 +--
docs/interfaces/WorkerInfo.html | 16 +-
docs/interfaces/WorkerOptions.html | 14 +-
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/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/TaskFunctions.html | 8 +-
docs/types/WorkerAsyncFunction.html | 8 +-
docs/types/WorkerChoiceStrategy.html | 8 +-
docs/types/WorkerFunction.html | 8 +-
docs/types/WorkerSyncFunction.html | 8 +-
docs/types/WorkerType.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 +-
60 files changed, 695 insertions(+), 695 deletions(-)
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index b715f582..73bf3040 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-AbstractPool | poolifier - v2.6.10
+AbstractPool | poolifier - v2.6.11
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:49
@@ -175,7 +175,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:94
Protected Readonly filePath
filePath: string
@@ -202,7 +202,7 @@
+
Defined in src/pools/abstract-pool.ts:96
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -210,7 +210,7 @@
+Defined in src/pools/abstract-pool.ts:95
Protected Readonly opts
@@ -218,7 +218,7 @@
+Defined in src/pools/abstract-pool.ts:97
Protected promiseResponseMap
@@ -231,7 +231,7 @@
+Defined in src/pools/abstract-pool.ts:68
Private Readonly startTimestamp
startTimestamp: number
@@ -239,7 +239,7 @@
+Defined in src/pools/abstract-pool.ts:85
Protected workerChoiceStrategyContext
@@ -247,7 +247,7 @@
+Defined in src/pools/abstract-pool.ts:76
Readonly workerNodes
@@ -256,7 +256,7 @@
+Defined in src/pools/abstract-pool.ts:55
Protected full
@@ -282,7 +282,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:562
+Defined in src/pools/abstract-pool.ts:268
Protected Abstract maxSize
@@ -305,7 +305,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:460
Protected Abstract minSize
@@ -316,7 +316,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:455
Private ready
@@ -324,7 +324,7 @@
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:412
Private starting
@@ -332,7 +332,7 @@
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:404
Protected Abstract type
@@ -344,7 +344,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:445
+Defined in src/pools/abstract-pool.ts:424
Protected Abstract worker
@@ -367,7 +367,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:450
Protected afterWorkerSetup
@@ -414,7 +414,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:911
Protected beforeTaskExecutionHook
@@ -439,7 +439,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:667
Private buildTasksQueueOptions
@@ -452,7 +452,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:549
Private checkAndEmitEvents
@@ -460,7 +460,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1074
Protected checkDynamicPoolSize
@@ -475,7 +475,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:160
Private checkFilePath
@@ -488,7 +488,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:133
Private checkMessageWorkerId
@@ -501,7 +501,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:473
Private checkNumberOfWorkers
@@ -514,7 +514,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:142
Private checkPoolOptions
@@ -527,7 +527,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:178
Private checkValidTasksQueueOptions
@@ -540,7 +540,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:243
Private checkValidWorkerChoiceStrategy
@@ -553,7 +553,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:205
Private checkValidWorkerChoiceStrategyOptions
@@ -566,7 +566,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:215
Private chooseWorkerNode
@@ -579,7 +579,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:853
Protected createAndSetupDynamicWorker
@@ -591,7 +591,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:994
Protected createAndSetupWorker
@@ -603,7 +603,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:928
Protected Abstract createWorker
@@ -615,7 +615,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:903
Private dequeueTask
@@ -628,7 +628,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1126
+Defined in src/pools/abstract-pool.ts:622
Protected Abstract destroyWorker
@@ -659,7 +659,7 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:643
+Defined in src/pools/abstract-pool.ts:527
Private enqueueTask
@@ -699,7 +699,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1122
+Defined in src/pools/abstract-pool.ts:587
Private executeTask
@@ -740,7 +740,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:1117
Private flushTasksQueue
@@ -753,7 +753,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1134
Private flushTasksQueues
@@ -761,7 +761,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1144
Private getWorkerById
@@ -781,7 +781,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:468
Private getWorkerInfo
@@ -800,7 +800,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1090
Private getWorkerNodeKey
@@ -820,7 +820,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:490
Private handleTaskExecutionResponse
@@ -833,7 +833,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1047
Private handleWorkerReadyMessage
@@ -846,7 +846,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1038
Protected internalBusy
@@ -858,7 +858,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:578
Protected Abstract isMain
@@ -869,7 +869,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:658
Private pushWorkerNode
@@ -889,7 +889,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1100
Private redistributeQueuedTasks
@@ -902,7 +902,7 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:961
Private registerWorkerMessageListener
@@ -942,7 +942,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:891
Private removeWorkerNode
@@ -961,7 +961,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1109
Protected Abstract sendToWorker
@@ -985,7 +985,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:880
+Defined in src/pools/abstract-pool.ts:539
+Defined in src/pools/abstract-pool.ts:497
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:516
Private setWorkerStatistics
@@ -1063,7 +1063,7 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:1150
Protected setupHook
@@ -1075,7 +1075,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:651
Private shallCreateDynamicWorker
@@ -1087,7 +1087,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:870
Private tasksQueueSize
@@ -1100,7 +1100,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1130
Private updateEluWorkerUsage
@@ -1115,7 +1115,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:782
Private updateRunTimeWorkerUsage
@@ -1130,7 +1130,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:706
Private updateTaskStatisticsWorkerUsage
@@ -1145,7 +1145,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:693
Private updateWaitTimeWorkerUsage
@@ -1160,7 +1160,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:744
Protected workerListener
@@ -1187,7 +1187,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1025
+
Defined in src/worker/abstract-worker.ts:58
Protected Abstract id
id: number
@@ -161,7 +161,7 @@
+Defined in src/worker/abstract-worker.ts:42
Protected Readonly isMain
isMain: boolean
@@ -169,7 +169,7 @@
+Defined in src/worker/abstract-worker.ts:70
Protected lastTaskTimestamp
lastTaskTimestamp: number
@@ -177,7 +177,7 @@
+Defined in src/worker/abstract-worker.ts:50
Protected Readonly mainWorker
mainWorker: MainWorker
@@ -185,7 +185,7 @@
+Defined in src/worker/abstract-worker.ts:74
Protected Readonly opts
@@ -193,7 +193,7 @@
+Defined in src/worker/abstract-worker.ts:75
Protected statistics
@@ -201,7 +201,7 @@
+Defined in src/worker/abstract-worker.ts:54
Protected taskFunctions
@@ -209,7 +209,7 @@
+Defined in src/worker/abstract-worker.ts:46
bind
@@ -268,7 +268,7 @@
Returns void
+Defined in src/worker/abstract-worker.ts:205
Private checkStatistics
@@ -276,7 +276,7 @@
-
Returns void
+Defined in src/worker/abstract-worker.ts:360
Private checkTaskFunctions
@@ -295,7 +295,7 @@
Returns void
+Defined in src/worker/abstract-worker.ts:107
Private checkWorkerOptions
Returns void
+Defined in src/worker/abstract-worker.ts:95
emitDestroy
@@ -337,7 +337,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:345
Protected getMainWorker
@@ -349,7 +349,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:219
Private getTaskFunction
@@ -368,7 +368,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:328
Protected handleError
@@ -388,7 +388,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:241
Protected messageListener
@@ -407,7 +407,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:147
Protected runAsync
@@ -431,7 +431,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:288
runInAsyncScope
@@ -510,7 +510,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:251
Protected Abstract sendToMainWorker
@@ -529,7 +529,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:231
Private startCheckAlive
@@ -540,7 +540,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:186
Private stopCheckAlive
@@ -551,7 +551,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:198
triggerAsyncId
@@ -573,7 +573,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:179
Static bind
@@ -661,7 +661,7 @@ then restore the original execution context.
- workerReady
- 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:88
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:80
entries
@@ -729,7 +729,7 @@ thisArg is omitted, undefined is used as the this value.
-
Returns boolean
+Defined in src/circular-array.ts:84
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:68
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
@@ -120,7 +120,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/cluster-worker.ts:31
Protected Readonly isMain
isMain: boolean
@@ -140,7 +140,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:70
Protected lastTaskTimestamp
lastTaskTimestamp: number
@@ -149,7 +149,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:50
Protected Readonly mainWorker
mainWorker: Worker
@@ -158,7 +158,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:74
Protected Readonly opts
@@ -167,7 +167,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:75
Protected statistics
@@ -176,7 +176,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:54
Protected taskFunctions
@@ -185,7 +185,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:46
Accessors
@@ -199,7 +199,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/cluster-worker.ts:47
+
Defined in src/worker/abstract-worker.ts:241
Protected messageListener
+
Defined in src/worker/abstract-worker.ts:147
+
Defined in src/worker/abstract-worker.ts:288
+
Defined in src/worker/abstract-worker.ts:251
Protected sendToMainWorker
+
Defined in src/worker/cluster-worker.ts:52
+
Defined in src/worker/abstract-worker.ts:179
Static bind
@@ -536,7 +536,7 @@ then restore the original execution context.
- workerReady
- bind
@@ -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
@@ -144,7 +144,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
@@ -154,7 +154,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Events that can currently be listened to:
+Defined in src/pools/abstract-pool.ts:58
Protected Readonly filePath
filePath: string
@@ -172,7 +172,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:96
Protected Readonly max
max: number
@@ -180,7 +180,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
@@ -189,7 +189,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:95
Protected Readonly opts
@@ -198,7 +198,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
@@ -212,7 +212,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:68
Protected workerChoiceStrategyContext
@@ -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
Readonly workerNodes
@@ -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:55
+
Defined in src/pools/abstract-pool.ts:562
+
Defined in src/pools/abstract-pool.ts:268
+
Defined in src/pools/cluster/dynamic.ts:43
+
Defined in src/pools/cluster/fixed.ts:92
+
Defined in src/pools/abstract-pool.ts:412
+
Defined in src/pools/abstract-pool.ts:404
+
Defined in src/pools/cluster/dynamic.ts:38
+
Defined in src/pools/abstract-pool.ts:424
+
Defined in src/pools/cluster/fixed.ts:87
Protected afterWorkerSetup
+
Defined in src/pools/abstract-pool.ts:911
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:667
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:160
Protected createAndSetupDynamicWorker
+
Defined in src/pools/abstract-pool.ts:994
Protected createAndSetupWorker
+
Defined in src/pools/abstract-pool.ts:928
+
Defined in src/pools/cluster/fixed.ts:77
+
Defined in src/pools/abstract-pool.ts:622
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:527
+
Defined in src/pools/abstract-pool.ts:587
+
Defined in src/pools/abstract-pool.ts:578
+
Defined in src/pools/cluster/fixed.ts:58
+
Defined in src/pools/cluster/fixed.ts:72
+
Defined in src/pools/abstract-pool.ts:539
+
Defined in src/pools/abstract-pool.ts:497
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:516
+
Defined in src/pools/cluster/fixed.ts:53
+Defined in src/pools/abstract-pool.ts:1025
@@ -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
@@ -144,7 +144,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
@@ -154,7 +154,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Events that can currently be listened to:
+Defined in src/pools/abstract-pool.ts:58
Protected Readonly filePath
filePath: string
@@ -172,7 +172,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:96
Protected Readonly max
max: number
@@ -180,7 +180,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
@@ -189,7 +189,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:95
Protected Readonly opts
@@ -198,7 +198,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/thread/fixed.ts:46
Protected promiseResponseMap
@@ -212,7 +212,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:68
Protected workerChoiceStrategyContext
@@ -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
Readonly workerNodes
@@ -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:55
Accessors
@@ -245,7 +245,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/thread/dynamic.ts:48
+
Defined in src/pools/abstract-pool.ts:562
+
Defined in src/pools/abstract-pool.ts:268
+
Defined in src/pools/thread/dynamic.ts:43
+
Defined in src/pools/thread/fixed.ts:86
+
Defined in src/pools/abstract-pool.ts:412
+
Defined in src/pools/abstract-pool.ts:404
+
Defined in src/pools/thread/dynamic.ts:38
+
Defined in src/pools/abstract-pool.ts:424
+
Defined in src/pools/thread/fixed.ts:81
Protected afterWorkerSetup
+
Defined in src/pools/abstract-pool.ts:911
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:667
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:160
Protected createAndSetupDynamicWorker
+
Defined in src/pools/abstract-pool.ts:994
Protected createAndSetupWorker
+
Defined in src/pools/abstract-pool.ts:928
+
Defined in src/pools/thread/fixed.ts:68
+
Defined in src/pools/abstract-pool.ts:622
+
Defined in src/pools/thread/fixed.ts:57
+
Defined in src/pools/abstract-pool.ts:527
+
Defined in src/pools/abstract-pool.ts:587
+
Defined in src/pools/abstract-pool.ts:578
+
Defined in src/pools/thread/fixed.ts:52
+
Defined in src/pools/thread/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:539
+
Defined in src/pools/abstract-pool.ts:497
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:516
+
Defined in src/pools/abstract-pool.ts:651
+Defined in src/pools/abstract-pool.ts:1025
@@ -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
@@ -166,7 +166,7 @@
+
Defined in src/pools/abstract-pool.ts:96
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -175,7 +175,7 @@
+
Defined in src/pools/abstract-pool.ts:95
Protected Readonly opts
@@ -184,7 +184,7 @@
+
Defined in src/pools/cluster/fixed.ts:47
Protected promiseResponseMap
@@ -198,7 +198,7 @@
+
Defined in src/pools/abstract-pool.ts:68
Protected workerChoiceStrategyContext
@@ -207,7 +207,7 @@
+
Defined in src/pools/abstract-pool.ts:76
Readonly workerNodes
@@ -216,7 +216,7 @@
+
Defined in src/pools/abstract-pool.ts:55
+
Defined in src/pools/abstract-pool.ts:562
+
Defined in src/pools/abstract-pool.ts:268
+
Defined in src/pools/cluster/fixed.ts:97
+
Defined in src/pools/cluster/fixed.ts:92
+
Defined in src/pools/abstract-pool.ts:412
+
Defined in src/pools/abstract-pool.ts:404
+
Defined in src/pools/cluster/fixed.ts:82
+
Defined in src/pools/abstract-pool.ts:424
+
Defined in src/pools/cluster/fixed.ts:87
Protected afterWorkerSetup
+
Defined in src/pools/abstract-pool.ts:911
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:667
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:160
Protected createAndSetupDynamicWorker
+
Defined in src/pools/abstract-pool.ts:994
Protected createAndSetupWorker
+
Defined in src/pools/abstract-pool.ts:928
+
Defined in src/pools/cluster/fixed.ts:77
+
Defined in src/pools/abstract-pool.ts:622
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:527
+
Defined in src/pools/abstract-pool.ts:587
+
Defined in src/pools/abstract-pool.ts:578
+
Defined in src/pools/cluster/fixed.ts:58
+
Defined in src/pools/cluster/fixed.ts:72
+
Defined in src/pools/abstract-pool.ts:539
+
Defined in src/pools/abstract-pool.ts:497
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:516
+
Defined in src/pools/cluster/fixed.ts:53
+
Defined in src/pools/abstract-pool.ts:1025
@@ -45,7 +45,7 @@
+
Defined in src/pools/thread/fixed.ts:32
+
Defined in src/pools/thread/fixed.ts:43
Protected Readonly filePath
filePath: string
@@ -166,7 +166,7 @@
+
Defined in src/pools/abstract-pool.ts:96
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -175,7 +175,7 @@
+
Defined in src/pools/abstract-pool.ts:95
Protected Readonly opts
@@ -184,7 +184,7 @@
+
Defined in src/pools/thread/fixed.ts:46
Protected promiseResponseMap
@@ -198,7 +198,7 @@
+
Defined in src/pools/abstract-pool.ts:68
Protected workerChoiceStrategyContext
@@ -207,7 +207,7 @@
+
Defined in src/pools/abstract-pool.ts:76
Readonly workerNodes
@@ -216,7 +216,7 @@
+
Defined in src/pools/abstract-pool.ts:55
+
Defined in src/pools/abstract-pool.ts:562
+
Defined in src/pools/abstract-pool.ts:268
+
Defined in src/pools/thread/fixed.ts:91
+
Defined in src/pools/thread/fixed.ts:86
+
Defined in src/pools/abstract-pool.ts:412
+
Defined in src/pools/abstract-pool.ts:404
+
Defined in src/pools/thread/fixed.ts:76
+
Defined in src/pools/abstract-pool.ts:424
+
Defined in src/pools/thread/fixed.ts:81
Protected afterWorkerSetup
+
Defined in src/pools/abstract-pool.ts:911
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:667
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:160
Protected createAndSetupDynamicWorker
+
Defined in src/pools/abstract-pool.ts:994
Protected createAndSetupWorker
+
Defined in src/pools/abstract-pool.ts:928
+
Defined in src/pools/thread/fixed.ts:68
+
Defined in src/pools/abstract-pool.ts:622
+
Defined in src/pools/thread/fixed.ts:57
+
Defined in src/pools/abstract-pool.ts:527
+
Defined in src/pools/abstract-pool.ts:587
+
Defined in src/pools/abstract-pool.ts:578
+
Defined in src/pools/thread/fixed.ts:52
+
Defined in src/pools/thread/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:539
+
Defined in src/pools/abstract-pool.ts:497
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:516
+
Defined in src/pools/abstract-pool.ts:651
+
Defined in src/pools/abstract-pool.ts:1025
@@ -26,7 +26,7 @@
+
Defined in src/pools/pool.ts:38
@@ -32,7 +32,7 @@
+
Defined in src/queue.ts:8
+
Defined in src/queue.ts:16
maxSize
maxSize: number
@@ -85,12 +85,12 @@
+
Defined in src/queue.ts:14
Private offset
offset: number
+
Defined in src/queue.ts:10
size
size: number
@@ -98,7 +98,7 @@
+Defined in src/queue.ts:12
+Defined in src/queue.ts:40
+Defined in src/queue.ts:26
+Defined in src/queue.ts:58
@@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:26
@@ -120,7 +120,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:36
Protected Readonly isMain
isMain: boolean
@@ -140,7 +140,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:70
Protected lastTaskTimestamp
lastTaskTimestamp: number
@@ -149,7 +149,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:50
Protected Readonly mainWorker
mainWorker: MessagePort
@@ -158,7 +158,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:74
Protected Readonly opts
@@ -167,7 +167,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:75
Protected statistics
@@ -176,7 +176,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:54
Protected taskFunctions
@@ -185,7 +185,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:46
Accessors
@@ -199,7 +199,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:51
+
Defined in src/worker/thread-worker.ts:61
Protected messageListener
+
Defined in src/worker/abstract-worker.ts:147
+
Defined in src/worker/abstract-worker.ts:288
+
Defined in src/worker/abstract-worker.ts:251
Protected sendToMainWorker
+
Defined in src/worker/thread-worker.ts:56
+
Defined in src/worker/abstract-worker.ts:179
Static bind
@@ -536,7 +536,7 @@ then restore the original execution context.
- workerReady
- bind
@@ -42,7 +42,7 @@
- WorkerChoiceStrategyContext
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:27
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:44
Private workerChoiceStrategy
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
@@ -121,7 +121,7 @@
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:46
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:167
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:113
getTaskStatisticsRequirements
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:126
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:185
setOptions
@@ -200,7 +200,7 @@
Returns void
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:198
setWorkerChoiceStrategy
@@ -219,7 +219,7 @@
Returns void
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:139
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:153
@@ -26,7 +26,7 @@ Always returns a value greater than zero.
+
Defined in src/utils.ts:41
-
poolifier - v2.6.10
+
poolifier - v2.6.11
Index
@@ -105,7 +105,7 @@
Theme
@@ -26,7 +26,7 @@
+
Defined in src/pools/cluster/fixed.ts:10
+
Defined in src/pools/pool.ts:147
Optional enableTasksQueue
enableTasksQueue?: boolean
@@ -70,7 +70,7 @@
+Defined in src/pools/pool.ts:153
+Defined in src/pools/cluster/fixed.ts:16
Optional errorHandler
@@ -89,7 +89,7 @@
+Defined in src/pools/pool.ts:119
Optional exitHandler
@@ -98,7 +98,7 @@
+Defined in src/pools/pool.ts:127
Optional messageHandler
@@ -107,7 +107,7 @@
+Defined in src/pools/pool.ts:115
Optional onlineHandler
@@ -116,7 +116,7 @@
+Defined in src/pools/pool.ts:123
Optional restartWorkerOnError
restartWorkerOnError?: boolean
@@ -125,7 +125,7 @@
+Defined in src/pools/pool.ts:141
+Defined in src/pools/cluster/fixed.ts:22
Optional tasksQueueOptions
@@ -144,7 +144,7 @@
+Defined in src/pools/pool.ts:157
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:133
Optional workerChoiceStrategyOptions
@@ -164,7 +164,7 @@
+Defined in src/pools/pool.ts:137
@@ -24,7 +24,7 @@
- EventLoopUtilizationMeasurementStatistics
+
Defined in src/pools/worker.ts:98
+
Defined in src/pools/worker.ts:99
Optional utilization
utilization?: number
+
Defined in src/pools/worker.ts:101
@@ -46,7 +46,7 @@
+
Defined in src/pools/pool.ts:167
@@ -81,7 +81,7 @@
Returns Promise<void>
+
Defined in src/pools/pool.ts:203
Optional Readonly emitter
@@ -89,7 +89,7 @@
Events that can currently be listened to:
'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'ready': Emitted when the number of workers created in the pool has reached the maximum size expected and are ready.'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'error': Emitted when an uncaught error occurs.'taskError': Emitted when an error occurs while executing a task.
+Defined in src/pools/pool.ts:191
Readonly enableTasksQueue
enableTasksQueue: ((enable, tasksQueueOptions?) => void)
@@ -126,7 +126,7 @@
Returns void
+Defined in src/pools/pool.ts:228
Readonly execute
execute: ((data?, name?) => Promise<Response>)
@@ -156,7 +156,7 @@
+Defined in src/pools/pool.ts:199
Readonly info
@@ -164,7 +164,7 @@
+Defined in src/pools/pool.ts:175
Readonly setTasksQueueOptions
setTasksQueueOptions: ((tasksQueueOptions) => void)
@@ -188,7 +188,7 @@
Returns void
+Defined in src/pools/pool.ts:237
Readonly setWorkerChoiceStrategy
setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
@@ -217,7 +217,7 @@
Returns void
+Defined in src/pools/pool.ts:210
Readonly setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
@@ -241,7 +241,7 @@
Returns void
+Defined in src/pools/pool.ts:219
Readonly workerNodes
@@ -249,7 +249,7 @@
+Defined in src/pools/pool.ts:179
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:196
+
Defined in src/pools/worker.ts:200
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:208
Readonly once
once: ((event, handler) => void)
@@ -147,12 +147,12 @@
Returns void
+Defined in src/pools/worker.ts:218
Optional Readonly threadId
threadId?: number
+Defined in src/pools/worker.ts:201
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:184
Readonly remove
remove: ((workerNodeKey) => boolean)
@@ -83,7 +83,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:191
Readonly reset
reset: (() => boolean)
@@ -100,7 +100,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:172
Readonly setOptions
setOptions: ((opts) => void)
@@ -124,7 +124,7 @@
Returns void
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:197
Readonly strategyPolicy
@@ -132,7 +132,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:162
Readonly taskStatisticsRequirements
@@ -140,7 +140,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:166
Readonly update
update: ((workerNodeKey) => boolean)
@@ -162,7 +162,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:178
@@ -37,7 +37,7 @@
+
Defined in src/pools/worker.ts:228
@@ -71,7 +71,7 @@
Returns void
+
Defined in src/pools/worker.ts:263
Readonly dequeueTask
dequeueTask: (() => undefined | Task<Data>)
@@ -88,7 +88,7 @@
+Defined in src/pools/worker.ts:259
Readonly enqueueTask
enqueueTask: ((task) => number)
@@ -113,7 +113,7 @@
+Defined in src/pools/worker.ts:253
Readonly info
@@ -121,7 +121,7 @@
+Defined in src/pools/worker.ts:236
Readonly resetUsage
resetUsage: (() => void)
@@ -137,7 +137,7 @@
Returns void
+Defined in src/pools/worker.ts:267
Readonly tasksQueueSize
tasksQueueSize: (() => number)
@@ -154,7 +154,7 @@
+Defined in src/pools/worker.ts:246
usage
@@ -162,7 +162,7 @@
+Defined in src/pools/worker.ts:240
Readonly worker
worker: Worker
@@ -170,7 +170,7 @@
+Defined in src/pools/worker.ts:232
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:65
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:66
+
Defined in src/pools/worker.ts:70
Optional average
average?: number
@@ -56,7 +56,7 @@
+Defined in src/pools/worker.ts:82
Readonly history
@@ -64,7 +64,7 @@
+Defined in src/pools/worker.ts:90
Optional maximum
maximum?: number
@@ -72,7 +72,7 @@
+Defined in src/pools/worker.ts:78
Optional median
median?: number
@@ -80,7 +80,7 @@
+Defined in src/pools/worker.ts:86
Optional minimum
minimum?: number
@@ -88,7 +88,7 @@
+Defined in src/pools/worker.ts:74
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:116
median
median: boolean
@@ -61,7 +61,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:120
@@ -39,7 +39,7 @@
+
Defined in src/utility-types.ts:58
+
Defined in src/utility-types.ts:83
Optional Readonly data
data?: Data
@@ -77,7 +77,7 @@
+
Defined in src/pools/worker.ts:50
Optional Readonly id
id?: string
@@ -86,7 +86,7 @@
+
Defined in src/pools/worker.ts:58
Optional Readonly kill
kill?: true | "SOFT" | "HARD"
@@ -94,7 +94,7 @@
+Defined in src/utility-types.ts:63
Optional Readonly name
name?: string
@@ -103,7 +103,7 @@
+Defined in src/pools/worker.ts:46
Optional Readonly ready
ready?: boolean
@@ -111,7 +111,7 @@
+Defined in src/utility-types.ts:79
Optional Readonly statistics
@@ -119,7 +119,7 @@
+Defined in src/utility-types.ts:75
Optional Readonly taskError
@@ -127,7 +127,7 @@
+Defined in src/utility-types.ts:67
Optional Readonly taskPerformance
@@ -135,7 +135,7 @@
+Defined in src/utility-types.ts:71
Optional Readonly timestamp
timestamp?: number
@@ -144,7 +144,7 @@
+Defined in src/pools/worker.ts:54
Readonly workerId
workerId: number
@@ -153,7 +153,7 @@
+Defined in src/pools/worker.ts:42
@@ -24,7 +24,7 @@
+
Defined in src/pools/pool.ts:59
+
Defined in src/pools/pool.ts:74
Readonly executedTasks
executedTasks: number
+
Defined in src/pools/pool.ts:75
Readonly executingTasks
executingTasks: number
+
Defined in src/pools/pool.ts:76
Readonly failedTasks
failedTasks: number
+
Defined in src/pools/pool.ts:79
Readonly idleWorkerNodes
idleWorkerNodes: number
@@ -83,32 +83,32 @@
+Defined in src/pools/pool.ts:72
Readonly maxQueuedTasks
maxQueuedTasks: number
+Defined in src/pools/pool.ts:78
Readonly maxSize
maxSize: number
+Defined in src/pools/pool.ts:66
Readonly minSize
minSize: number
+Defined in src/pools/pool.ts:65
Readonly queuedTasks
queuedTasks: number
+Defined in src/pools/pool.ts:77
Readonly ready
ready: boolean
+Defined in src/pools/pool.ts:63
Optional Readonly runTime
runTime?: {
    average: number;
    maximum: number;
    median?: number;
    minimum: number;
}
@@ -124,17 +124,17 @@
Readonly minimum: number
+Defined in src/pools/pool.ts:80
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:64
Readonly type
type: "fixed" | "dynamic"
+Defined in src/pools/pool.ts:61
Optional Readonly utilization
utilization?: number
@@ -142,12 +142,12 @@
+Defined in src/pools/pool.ts:68
Readonly version
version: string
+Defined in src/pools/pool.ts:60
Optional Readonly waitTime
waitTime?: {
    average: number;
    maximum: number;
    median?: number;
    minimum: number;
}
@@ -163,12 +163,12 @@
Readonly minimum: number
+Defined in src/pools/pool.ts:86
Readonly worker
worker: "cluster" | "thread"
+Defined in src/pools/pool.ts:62
Readonly workerNodes
workerNodes: number
@@ -176,7 +176,7 @@
+Defined in src/pools/pool.ts:70
@@ -35,7 +35,7 @@
ClusterPoolOptions
ThreadPoolOptions
+
Defined in src/pools/pool.ts:111
@@ -65,7 +65,7 @@
Default Value
true
+
Defined in src/pools/pool.ts:147
Optional enableTasksQueue
enableTasksQueue?: boolean
@@ -75,7 +75,7 @@
Default Value
false
+Defined in src/pools/pool.ts:153
Optional errorHandler
@@ -83,7 +83,7 @@
+Defined in src/pools/pool.ts:119
Optional exitHandler
@@ -91,7 +91,7 @@
+Defined in src/pools/pool.ts:127
Optional messageHandler
@@ -99,7 +99,7 @@
+Defined in src/pools/pool.ts:115
Optional onlineHandler
@@ -107,7 +107,7 @@
+Defined in src/pools/pool.ts:123
Optional restartWorkerOnError
restartWorkerOnError?: boolean
@@ -115,7 +115,7 @@
+Defined in src/pools/pool.ts:141
Optional tasksQueueOptions
@@ -123,7 +123,7 @@
+Defined in src/pools/pool.ts:157
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:133
Optional workerChoiceStrategyOptions
@@ -141,7 +141,7 @@
+Defined in src/pools/pool.ts:137
@@ -37,7 +37,7 @@
+
Defined in src/utility-types.ts:93
@@ -71,7 +71,7 @@
Returns void
+
Defined in src/utility-types.ts:104
Readonly resolve
resolve: ((value) => void)
@@ -92,7 +92,7 @@
Returns void
+Defined in src/utility-types.ts:100
Readonly worker
worker: Worker
@@ -100,7 +100,7 @@
+Defined in src/utility-types.ts:108
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:152
@@ -34,7 +34,7 @@
+
Defined in src/pools/worker.ts:38
+
Defined in src/pools/worker.ts:50
Optional Readonly id
id?: string
@@ -65,7 +65,7 @@
+Defined in src/pools/worker.ts:58
Optional Readonly name
name?: string
@@ -73,7 +73,7 @@
+Defined in src/pools/worker.ts:46
Optional Readonly timestamp
timestamp?: number
@@ -81,7 +81,7 @@
+Defined in src/pools/worker.ts:54
Readonly workerId
workerId: number
@@ -89,7 +89,7 @@
+Defined in src/pools/worker.ts:42
@@ -32,7 +32,7 @@
+
Defined in src/utility-types.ts:10
+
Defined in src/utility-types.ts:18
Readonly message
message: string
@@ -60,7 +60,7 @@
+Defined in src/utility-types.ts:14
@@ -24,7 +24,7 @@
+
Defined in src/utility-types.ts:26
+
Defined in src/utility-types.ts:38
Optional Readonly runTime
runTime?: number
@@ -53,7 +53,7 @@
+Defined in src/utility-types.ts:34
Readonly timestamp
timestamp: number
@@ -61,7 +61,7 @@
+Defined in src/utility-types.ts:30
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:109
+
Defined in src/pools/worker.ts:113
executing
executing: number
@@ -55,7 +55,7 @@
+Defined in src/pools/worker.ts:117
failed
failed: number
@@ -63,7 +63,7 @@
+Defined in src/pools/worker.ts:129
Readonly maxQueued
maxQueued: number
@@ -71,7 +71,7 @@
+Defined in src/pools/worker.ts:125
Readonly queued
queued: number
@@ -79,7 +79,7 @@
+Defined in src/pools/worker.ts:121
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:132
Readonly waitTime
@@ -61,7 +61,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:136
@@ -24,7 +24,7 @@
+
Defined in src/pools/pool.ts:97
@@ -45,7 +45,7 @@
Default Value
1
+Defined in src/pools/pool.ts:103
@@ -26,7 +26,7 @@
+
Defined in src/pools/thread/fixed.ts:15
+
Defined in src/pools/pool.ts:147
Optional enableTasksQueue
enableTasksQueue?: boolean
@@ -69,7 +69,7 @@
+Defined in src/pools/pool.ts:153
Optional errorHandler
@@ -78,7 +78,7 @@
+Defined in src/pools/pool.ts:119
Optional exitHandler
@@ -87,7 +87,7 @@
+Defined in src/pools/pool.ts:127
Optional messageHandler
@@ -96,7 +96,7 @@
+Defined in src/pools/pool.ts:115
Optional onlineHandler
@@ -105,7 +105,7 @@
+Defined in src/pools/pool.ts:123
Optional restartWorkerOnError
restartWorkerOnError?: boolean
@@ -114,7 +114,7 @@
+Defined in src/pools/pool.ts:141
Optional tasksQueueOptions
@@ -123,7 +123,7 @@
+Defined in src/pools/pool.ts:157
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:133
Optional workerChoiceStrategyOptions
@@ -143,7 +143,7 @@
+Defined in src/pools/pool.ts:137
+Defined in src/pools/thread/fixed.ts:21
@@ -24,7 +24,7 @@
- WorkerChoiceStrategyOptions
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:71
@@ -49,7 +49,7 @@
Default Value
{ median: false }
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:93
Optional Readonly measurement
measurement?: "runTime" | "waitTime" | "elu"
@@ -57,7 +57,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:75
Optional Readonly runTime
@@ -67,7 +67,7 @@
Default Value
{ median: false }
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:81
Optional Readonly waitTime
@@ -77,7 +77,7 @@
Default Value
{ median: false }
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:87
Optional Readonly weights
weights?: Record<number, number>
@@ -88,7 +88,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:100
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:150
+
Defined in src/pools/worker.ts:162
Readonly id
id: undefined | number
@@ -54,7 +54,7 @@
+Defined in src/pools/worker.ts:154
ready
ready: boolean
@@ -62,7 +62,7 @@
+Defined in src/pools/worker.ts:166
type
type: "cluster" | "thread"
@@ -70,7 +70,7 @@
+Defined in src/pools/worker.ts:158
@@ -24,7 +24,7 @@
+
Defined in src/worker/worker-options.ts:23
@@ -49,7 +49,7 @@
Deprecated
This option will be removed in the next major version.
+
Defined in src/worker/worker-options.ts:43
Optional killBehavior
killBehavior?: "SOFT" | "HARD"
@@ -64,7 +64,7 @@
Default Value
KillBehaviors.SOFT
+Defined in src/worker/worker-options.ts:54
Optional maxInactiveTime
maxInactiveTime?: number
@@ -81,7 +81,7 @@ when this timeout expires your tasks is interrupted and the worker is killed if
Default Value
60000
+Defined in src/worker/worker-options.ts:36
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:174
+
Defined in src/pools/worker.ts:190
Readonly runTime
@@ -54,7 +54,7 @@
+Defined in src/pools/worker.ts:182
Readonly tasks
@@ -62,7 +62,7 @@
+Defined in src/pools/worker.ts:178
Readonly waitTime
@@ -70,7 +70,7 @@
+Defined in src/pools/worker.ts:186
@@ -40,7 +40,7 @@
Returns void
+Defined in src/pools/worker.ts:14
@@ -40,7 +40,7 @@
Returns void
+Defined in src/pools/worker.ts:27
+Defined in src/worker/worker-options.ts:18
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:56
@@ -40,7 +40,7 @@
Returns void
+Defined in src/pools/worker.ts:6
@@ -38,7 +38,7 @@
Returns void
+Defined in src/pools/worker.ts:22
+Defined in src/pools/pool.ts:54
+Defined in src/pools/pool.ts:33
@@ -36,7 +36,7 @@ The value is the function itself.
+
Defined in src/worker/worker-functions.ts:42
@@ -47,7 +47,7 @@ This function must return a promise.
Returns Promise<Response>
+Defined in src/worker/worker-functions.ts:18
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:42
@@ -34,7 +34,7 @@ This function can be synchronous or asynchronous.
+
Defined in src/worker/worker-functions.ts:29
@@ -46,7 +46,7 @@
Returns Response
+Defined in src/worker/worker-functions.ts:7
+Defined in src/pools/worker.ts:143
+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:47
@@ -33,7 +33,7 @@
Readonly taskError: "taskError"
+Defined in src/pools/pool.ts:43
+Defined in src/pools/pool.ts:19
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
@@ -27,7 +27,7 @@
Readonly thread: "thread"
+Defined in src/pools/worker.ts:135