From f4ff239c096df6dfb39c94eb3f83fd070d3d85d8 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Fri, 11 Aug 2023 20:00:21 +0000
Subject: [PATCH] chore: generate documentation
---
docs/classes/AbstractPool.html | 152 +++++++++---------
docs/classes/AbstractWorker.html | 74 ++++-----
docs/classes/CircularArray.html | 28 ++--
docs/classes/ClusterWorker.html | 52 +++---
docs/classes/DynamicClusterPool.html | 92 +++++------
docs/classes/DynamicThreadPool.html | 92 +++++------
docs/classes/FixedClusterPool.html | 90 +++++------
docs/classes/FixedThreadPool.html | 90 +++++------
docs/classes/PoolEmitter.html | 8 +-
docs/classes/Queue.html | 28 ++--
docs/classes/ThreadWorker.html | 54 +++----
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 | 26 +--
docs/interfaces/IWorker.html | 16 +-
docs/interfaces/IWorkerChoiceStrategy.html | 22 +--
docs/interfaces/IWorkerNode.html | 28 ++--
docs/interfaces/MeasurementOptions.html | 10 +-
docs/interfaces/MeasurementStatistics.html | 20 +--
.../MeasurementStatisticsRequirements.html | 14 +-
docs/interfaces/MessageValue.html | 32 ++--
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 | 14 +-
docs/interfaces/TaskPerformance.html | 16 +-
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 | 18 +--
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/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/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, 736 insertions(+), 736 deletions(-)
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 925961b5..27ed4997 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-AbstractPool | poolifier - v2.6.22
+AbstractPool | poolifier - v2.6.23
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:55
@@ -177,7 +177,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:102
Protected Readonly filePath
filePath: string
@@ -204,7 +204,7 @@
+
Defined in src/pools/abstract-pool.ts:104
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -212,7 +212,7 @@
+Defined in src/pools/abstract-pool.ts:103
Protected Readonly opts
@@ -220,7 +220,7 @@
+Defined in src/pools/abstract-pool.ts:105
Protected promiseResponseMap
@@ -233,7 +233,7 @@
+Defined in src/pools/abstract-pool.ts:74
Private Readonly startTimestamp
startTimestamp: number
@@ -241,7 +241,7 @@
+Defined in src/pools/abstract-pool.ts:93
Private Readonly starting
starting: boolean
@@ -249,7 +249,7 @@
+Defined in src/pools/abstract-pool.ts:89
Protected workerChoiceStrategyContext
@@ -257,7 +257,7 @@
+Defined in src/pools/abstract-pool.ts:80
Readonly workerNodes
@@ -266,7 +266,7 @@
+Defined in src/pools/abstract-pool.ts:61
Protected full
@@ -292,7 +292,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:606
+Defined in src/pools/abstract-pool.ts:301
Protected Abstract maxSize
@@ -315,7 +315,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:497
Protected Abstract minSize
@@ -326,7 +326,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:492
Private ready
@@ -337,7 +337,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:444
Protected Abstract type
@@ -349,7 +349,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:482
+Defined in src/pools/abstract-pool.ts:461
Protected Abstract worker
@@ -372,7 +372,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:487
Protected afterTaskExecutionHook
@@ -421,7 +421,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:733
Protected afterWorkerNodeSetup
@@ -441,7 +441,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:962
Protected beforeTaskExecutionHook
@@ -466,7 +466,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:712
Private buildTasksQueueOptions
@@ -479,7 +479,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:593
Private checkAndEmitEvents
@@ -487,7 +487,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1096
Protected checkDynamicPoolSize
@@ -502,7 +502,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:173
Private checkFilePath
@@ -515,7 +515,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:142
Private checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:505
Private checkNumberOfWorkers
@@ -549,7 +549,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:155
Private checkPoolOptions
@@ -562,7 +562,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:199
Private checkValidTasksQueueOptions
@@ -575,7 +575,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:264
Private checkValidWorkerChoiceStrategy
@@ -588,7 +588,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:226
Private checkValidWorkerChoiceStrategyOptions
@@ -601,7 +601,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:236
Private chooseWorkerNode
@@ -614,7 +614,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:827
Protected createAndSetupDynamicWorkerNode
@@ -626,7 +626,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:911
Protected createAndSetupWorkerNode
@@ -638,7 +638,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:871
Protected Abstract createWorker
@@ -650,7 +650,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:864
Private dequeueTask
@@ -663,7 +663,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1166
+Defined in src/pools/abstract-pool.ts:675
Protected Abstract destroyWorkerNode
@@ -694,7 +694,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:688
+Defined in src/pools/abstract-pool.ts:571
Private enqueueTask
@@ -734,7 +734,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1162
+Defined in src/pools/abstract-pool.ts:643
Private executeTask
@@ -784,7 +784,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1157
Protected flushTasksQueue
@@ -797,7 +797,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1174
Private flushTasksQueues
@@ -805,7 +805,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1184
Protected getWorkerInfo
@@ -825,7 +825,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1113
Private getWorkerNodeKeyByWorker
@@ -845,7 +845,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:522
Private getWorkerNodeKeyByWorkerId
@@ -865,7 +865,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:534
Private handleTaskExecutionResponse
@@ -878,7 +878,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1067
Private handleWorkerReadyResponse
@@ -891,19 +891,19 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1058
Protected internalBusy
- internalBusy(): boolean
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:996
Protected Abstract registerWorkerMessageListener
@@ -967,7 +967,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:949
Private removeWorkerNode
@@ -986,7 +986,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1143
Protected Abstract sendStartupMessageToWorker
@@ -1005,7 +1005,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:976
Protected Abstract sendToWorker
@@ -1029,7 +1029,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:854
Private sendWorkerStatisticsMessageToWorker
@@ -1048,7 +1048,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:983
+Defined in src/pools/abstract-pool.ts:583
+Defined in src/pools/abstract-pool.ts:541
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:560
Protected setupHook
@@ -1125,7 +1125,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:696
Private shallCreateDynamicWorker
@@ -1137,7 +1137,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:844
Private startPool
@@ -1145,7 +1145,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:288
Private tasksQueueSize
@@ -1158,7 +1158,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1170
Private updateEluWorkerUsage
@@ -1173,7 +1173,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:788
Private updateRunTimeWorkerUsage
@@ -1188,7 +1188,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:762
Private updateTaskStatisticsWorkerUsage
@@ -1203,7 +1203,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:749
Private updateWaitTimeWorkerUsage
@@ -1218,7 +1218,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:774
Protected workerListener
@@ -1245,7 +1245,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1045
+
Defined in src/worker/abstract-worker.ts:63
Protected Abstract id
id: number
@@ -169,7 +169,7 @@
+Defined in src/worker/abstract-worker.ts:47
Protected Readonly isMain
isMain: boolean
@@ -177,7 +177,7 @@
+Defined in src/worker/abstract-worker.ts:75
Protected lastTaskTimestamp
lastTaskTimestamp: number
@@ -185,7 +185,7 @@
+Defined in src/worker/abstract-worker.ts:55
Private Readonly mainWorker
mainWorker: MainWorker
@@ -193,7 +193,7 @@
+Defined in src/worker/abstract-worker.ts:76
Protected Readonly opts
@@ -201,7 +201,7 @@
+Defined in src/worker/abstract-worker.ts:78
Protected statistics
@@ -209,7 +209,7 @@
+Defined in src/worker/abstract-worker.ts:59
Protected taskFunctions
@@ -217,7 +217,7 @@
+Defined in src/worker/abstract-worker.ts:51
asyncId
@@ -275,7 +275,7 @@ If a task function with the same name already exists, it is replaced.
Optional name: string
+Defined in src/worker/abstract-worker.ts:501
bind
@@ -313,7 +313,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:351
Private checkStatistics
@@ -321,7 +321,7 @@ If a task function with the same name already exists, it is replaced.
-
Returns void
+Defined in src/worker/abstract-worker.ts:525
Private checkTaskFunctions
@@ -340,7 +340,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:110
Private checkWorkerOptions
@@ -353,7 +353,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
@@ -382,7 +382,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:510
Protected getMainWorker
@@ -394,7 +394,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:365
+Defined in src/worker/abstract-worker.ts:492
Protected handleError
@@ -436,7 +436,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:387
Protected handleKillMessage
@@ -455,7 +455,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:322
Protected Abstract handleReadyMessage
@@ -474,7 +474,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:288
+Defined in src/worker/abstract-worker.ts:164
listTaskFunctions
@@ -508,7 +508,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:245
Protected messageListener
@@ -527,7 +527,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:295
+Defined in src/worker/abstract-worker.ts:221
+Defined in src/worker/abstract-worker.ts:397
Protected runAsync
@@ -598,7 +598,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:451
runInAsyncScope
@@ -677,7 +677,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:415
Protected Abstract sendToMainWorker
@@ -696,7 +696,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:377
+Defined in src/worker/abstract-worker.ts:258
Private startCheckActive
@@ -733,7 +733,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:330
Private stopCheckActive
@@ -744,7 +744,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:341
triggerAsyncId
@@ -763,7 +763,7 @@ then restore the original execution context.
-
Returns void
+Defined in src/worker/abstract-worker.ts:531
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
@@ -126,7 +126,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/cluster-worker.ts:31
Protected Readonly isMain
isMain: boolean
@@ -146,7 +146,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:75
Protected lastTaskTimestamp
lastTaskTimestamp: number
@@ -155,7 +155,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:55
Protected Readonly opts
@@ -164,7 +164,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:78
Protected statistics
@@ -173,7 +173,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:59
Protected taskFunctions
@@ -182,7 +182,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:51
Accessors
@@ -196,7 +196,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/cluster-worker.ts:53
Methods
@@ -231,7 +231,7 @@ If a task function with the same name already exists, it is replaced.
+
Defined in src/worker/abstract-worker.ts:182
+
Defined in src/worker/abstract-worker.ts:365
+
Defined in src/worker/abstract-worker.ts:387
Protected handleKillMessage
+
Defined in src/worker/abstract-worker.ts:322
Protected handleReadyMessage
+
Defined in src/worker/cluster-worker.ts:45
hasTaskFunction
@@ -382,7 +382,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:164
+Defined in src/worker/abstract-worker.ts:245
Protected messageListener
+Defined in src/worker/abstract-worker.ts:295
+Defined in src/worker/abstract-worker.ts:221
+Defined in src/worker/abstract-worker.ts:397
+Defined in src/worker/abstract-worker.ts:451
+Defined in src/worker/abstract-worker.ts:415
Protected sendToMainWorker
+Defined in src/worker/cluster-worker.ts:58
+Defined in src/worker/abstract-worker.ts:258
triggerAsyncId
@@ -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
@@ -147,7 +147,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
@@ -166,7 +166,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:64
Protected Readonly filePath
filePath: string
@@ -175,7 +175,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:104
Protected Readonly max
max: number
@@ -183,7 +183,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
@@ -192,7 +192,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:103
Protected Readonly opts
@@ -201,7 +201,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
@@ -215,7 +215,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:74
Protected workerChoiceStrategyContext
@@ -224,7 +224,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:80
Readonly workerNodes
@@ -233,7 +233,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:61
+
Defined in src/pools/abstract-pool.ts:606
+
Defined in src/pools/abstract-pool.ts:301
+
Defined in src/pools/cluster/dynamic.ts:43
+
Defined in src/pools/cluster/fixed.ts:120
+
Defined in src/pools/abstract-pool.ts:444
+
Defined in src/pools/cluster/dynamic.ts:38
+
Defined in src/pools/abstract-pool.ts:461
+
Defined in src/pools/cluster/fixed.ts:115
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:962
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:712
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:173
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:911
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:871
+
Defined in src/pools/cluster/fixed.ts:105
+
Defined in src/pools/abstract-pool.ts:675
Protected destroyWorkerNode
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:571
+
Defined in src/pools/abstract-pool.ts:643
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1174
+
Defined in src/pools/abstract-pool.ts:1113
@@ -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
@@ -147,7 +147,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
@@ -166,7 +166,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:64
Protected Readonly filePath
filePath: string
@@ -175,7 +175,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:104
Protected Readonly max
max: number
@@ -183,7 +183,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
@@ -192,7 +192,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:103
Protected Readonly opts
@@ -201,7 +201,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/thread/fixed.ts:48
Protected promiseResponseMap
@@ -215,7 +215,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:74
Protected workerChoiceStrategyContext
@@ -224,7 +224,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:80
Readonly workerNodes
@@ -233,7 +233,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:61
Accessors
@@ -248,7 +248,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:606
+
Defined in src/pools/abstract-pool.ts:301
+
Defined in src/pools/thread/dynamic.ts:43
+
Defined in src/pools/thread/fixed.ts:130
+
Defined in src/pools/abstract-pool.ts:444
+
Defined in src/pools/thread/dynamic.ts:38
+
Defined in src/pools/abstract-pool.ts:461
+
Defined in src/pools/thread/fixed.ts:125
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:962
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:712
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:173
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:911
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:871
+
Defined in src/pools/thread/fixed.ts:112
+
Defined in src/pools/abstract-pool.ts:675
Protected destroyWorkerNode
+
Defined in src/pools/thread/fixed.ts:59
+
Defined in src/pools/abstract-pool.ts:571
+
Defined in src/pools/abstract-pool.ts:643
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1174
+
Defined in src/pools/abstract-pool.ts:1113
@@ -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
@@ -169,7 +169,7 @@
+
Defined in src/pools/abstract-pool.ts:104
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -178,7 +178,7 @@
+
Defined in src/pools/abstract-pool.ts:103
Protected Readonly opts
@@ -187,7 +187,7 @@
+
Defined in src/pools/cluster/fixed.ts:47
Protected promiseResponseMap
@@ -201,7 +201,7 @@
+
Defined in src/pools/abstract-pool.ts:74
Protected workerChoiceStrategyContext
@@ -210,7 +210,7 @@
+
Defined in src/pools/abstract-pool.ts:80
Readonly workerNodes
@@ -219,7 +219,7 @@
+
Defined in src/pools/abstract-pool.ts:61
+
Defined in src/pools/abstract-pool.ts:606
+
Defined in src/pools/abstract-pool.ts:301
+
Defined in src/pools/cluster/fixed.ts:125
+
Defined in src/pools/cluster/fixed.ts:120
+
Defined in src/pools/abstract-pool.ts:444
+
Defined in src/pools/cluster/fixed.ts:110
+
Defined in src/pools/abstract-pool.ts:461
+
Defined in src/pools/cluster/fixed.ts:115
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:962
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:712
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:173
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:911
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:871
+
Defined in src/pools/cluster/fixed.ts:105
+
Defined in src/pools/abstract-pool.ts:675
Protected destroyWorkerNode
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:571
+
Defined in src/pools/abstract-pool.ts:643
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1174
+
Defined in src/pools/abstract-pool.ts:1113
@@ -45,7 +45,7 @@
+
Defined in src/pools/thread/fixed.ts:34
+
Defined in src/pools/thread/fixed.ts:45
Protected Readonly filePath
filePath: string
@@ -169,7 +169,7 @@
+
Defined in src/pools/abstract-pool.ts:104
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -178,7 +178,7 @@
+
Defined in src/pools/abstract-pool.ts:103
Protected Readonly opts
@@ -187,7 +187,7 @@
+
Defined in src/pools/thread/fixed.ts:48
Protected promiseResponseMap
@@ -201,7 +201,7 @@
+
Defined in src/pools/abstract-pool.ts:74
Protected workerChoiceStrategyContext
@@ -210,7 +210,7 @@
+
Defined in src/pools/abstract-pool.ts:80
Readonly workerNodes
@@ -219,7 +219,7 @@
+
Defined in src/pools/abstract-pool.ts:61
+
Defined in src/pools/abstract-pool.ts:606
+
Defined in src/pools/abstract-pool.ts:301
+
Defined in src/pools/thread/fixed.ts:135
+
Defined in src/pools/thread/fixed.ts:130
+
Defined in src/pools/abstract-pool.ts:444
+
Defined in src/pools/thread/fixed.ts:120
+
Defined in src/pools/abstract-pool.ts:461
+
Defined in src/pools/thread/fixed.ts:125
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:962
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:712
Protected checkDynamicPoolSize
+
Defined in src/pools/abstract-pool.ts:173
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:911
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:871
+
Defined in src/pools/thread/fixed.ts:112
+
Defined in src/pools/abstract-pool.ts:675
Protected destroyWorkerNode
+
Defined in src/pools/thread/fixed.ts:59
+
Defined in src/pools/abstract-pool.ts:571
+
Defined in src/pools/abstract-pool.ts:643
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1174
+
Defined in src/pools/abstract-pool.ts:1113
@@ -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
@@ -86,12 +86,12 @@
+
Defined in src/queue.ts:14
Private offset
offset: number
+
Defined in src/queue.ts:10
size
size: number
@@ -99,7 +99,7 @@
+
Defined in src/queue.ts:12
+Defined in src/queue.ts:81
clear
@@ -126,7 +126,7 @@
Returns void
+Defined in src/queue.ts:68
+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
@@ -127,7 +127,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:40
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:75
Protected lastTaskTimestamp
lastTaskTimestamp: number
@@ -156,7 +156,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:55
Protected Readonly opts
@@ -165,7 +165,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:78
Private port
port: MessagePort
@@ -173,7 +173,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:33
Protected statistics
@@ -182,7 +182,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:59
Protected taskFunctions
@@ -191,7 +191,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:51
Accessors
@@ -205,7 +205,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:75
Methods
@@ -240,7 +240,7 @@ If a task function with the same name already exists, it is replaced.
+Defined in src/worker/abstract-worker.ts:182
+Defined in src/worker/abstract-worker.ts:365
+Defined in src/worker/thread-worker.ts:85
Protected handleKillMessage
+Defined in src/worker/thread-worker.ts:68
Protected handleReadyMessage
+Defined in src/worker/thread-worker.ts:54
+Defined in src/worker/abstract-worker.ts:164
+Defined in src/worker/abstract-worker.ts:245
Protected messageListener
+Defined in src/worker/abstract-worker.ts:295
+Defined in src/worker/abstract-worker.ts:221
+Defined in src/worker/abstract-worker.ts:397
+Defined in src/worker/abstract-worker.ts:451
+Defined in src/worker/abstract-worker.ts:415
Protected sendToMainWorker
+Defined in src/worker/thread-worker.ts:80
+Defined in src/worker/abstract-worker.ts:258
+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:47
-
poolifier - v2.6.22
+
poolifier - v2.6.23
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: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:167
@@ -81,7 +81,7 @@
Returns Promise<void>
+
Defined in src/pools/pool.ts:203
Optional Readonly emitter
@@ -97,7 +97,7 @@
+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: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
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:186
Readonly remove
remove: ((workerNodeKey) => boolean)
@@ -83,7 +83,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:193
Readonly reset
reset: (() => boolean)
@@ -100,7 +100,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:174
Readonly setOptions
setOptions: ((opts) => void)
@@ -124,7 +124,7 @@
Returns void
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:199
Readonly strategyPolicy
@@ -132,7 +132,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:164
Readonly taskStatisticsRequirements
@@ -140,7 +140,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:168
Readonly update
update: ((workerNodeKey) => boolean)
@@ -162,7 +162,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:180
@@ -37,7 +37,7 @@
+
Defined in src/pools/worker.ts:205
@@ -73,7 +73,7 @@
Returns void
+
Defined in src/pools/worker.ts:240
Readonly closeChannel
closeChannel: (() => void)
@@ -89,7 +89,7 @@
Returns void
+Defined in src/pools/worker.ts:248
Readonly dequeueTask
dequeueTask: (() => undefined | Task<Data>)
@@ -106,7 +106,7 @@
+Defined in src/pools/worker.ts:236
Readonly enqueueTask
enqueueTask: ((task) => number)
@@ -131,7 +131,7 @@
+Defined in src/pools/worker.ts:230
Readonly getTaskWorkerUsage
getTaskWorkerUsage: ((name) => undefined | WorkerUsage)
@@ -152,7 +152,7 @@
+Defined in src/pools/worker.ts:252
Readonly info
@@ -160,7 +160,7 @@
+Defined in src/pools/worker.ts:213
Readonly resetUsage
resetUsage: (() => void)
@@ -176,7 +176,7 @@
Returns void
+Defined in src/pools/worker.ts:244
Readonly tasksQueueSize
tasksQueueSize: (() => number)
@@ -193,7 +193,7 @@
+Defined in src/pools/worker.ts:223
usage
@@ -201,7 +201,7 @@
+Defined in src/pools/worker.ts:217
Readonly worker
worker: Worker
@@ -209,7 +209,7 @@
+Defined in src/pools/worker.ts:209
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:65
@@ -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: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:95
+
Defined in src/utility-types.ts:120
Optional Readonly data
data?: Data
@@ -78,7 +78,7 @@
+
Defined in src/utility-types.ts:77
Optional Readonly kill
kill?: true | "SOFT" | "HARD"
@@ -86,7 +86,7 @@
+Defined in src/utility-types.ts:100
Optional Readonly name
name?: string
@@ -95,7 +95,7 @@
+Defined in src/utility-types.ts:73
Optional Readonly port
port?: MessagePort
@@ -103,7 +103,7 @@
+Defined in src/utility-types.ts:124
Optional Readonly ready
ready?: boolean
@@ -111,7 +111,7 @@
+Defined in src/utility-types.ts:116
Optional Readonly statistics
@@ -119,7 +119,7 @@
+Defined in src/utility-types.ts:112
Optional Readonly taskError
@@ -127,7 +127,7 @@
+Defined in src/utility-types.ts:104
Optional Readonly taskId
taskId?: string
@@ -136,7 +136,7 @@
+Defined in src/utility-types.ts:85
Optional Readonly taskPerformance
@@ -144,7 +144,7 @@
+Defined in src/utility-types.ts:108
Optional Readonly timestamp
timestamp?: number
@@ -153,7 +153,7 @@
+Defined in src/utility-types.ts:81
Readonly workerId
workerId: number
@@ -162,7 +162,7 @@
+Defined in src/utility-types.ts:69
@@ -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
Optional 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
Optional 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: "thread" | "cluster"
+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
@@ -32,7 +32,7 @@
+
Defined in src/utility-types.ts:133
@@ -66,7 +66,7 @@
Returns void
+
Defined in src/utility-types.ts:141
Readonly resolve
resolve: ((value) => void)
@@ -87,7 +87,7 @@
Returns void
+Defined in src/utility-types.ts:137
Readonly workerNodeKey
workerNodeKey: number
@@ -95,7 +95,7 @@
+Defined in src/utility-types.ts:145
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:152
@@ -34,7 +34,7 @@
+
Defined in src/utility-types.ts:65
+
Defined in src/utility-types.ts:77
Optional Readonly name
name?: string
@@ -65,7 +65,7 @@
+Defined in src/utility-types.ts:73
Optional Readonly taskId
taskId?: string
@@ -73,7 +73,7 @@
+Defined in src/utility-types.ts:85
Optional Readonly timestamp
timestamp?: number
@@ -81,7 +81,7 @@
+Defined in src/utility-types.ts:81
Readonly workerId
workerId: number
@@ -89,7 +89,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: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:17
+
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:23
@@ -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:123
+
Defined in src/pools/worker.ts:135
Readonly id
id: undefined | number
@@ -55,7 +55,7 @@
+Defined in src/pools/worker.ts:127
Optional messageChannel
messageChannel?: MessageChannel
@@ -63,7 +63,7 @@
+Defined in src/pools/worker.ts:143
ready
ready: boolean
@@ -71,7 +71,7 @@
+Defined in src/pools/worker.ts:139
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: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 before completion and remove
Default Value
60000
+Defined in src/worker/worker-options.ts:36
@@ -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:16
@@ -40,7 +40,7 @@
Returns void
+Defined in src/pools/worker.ts:29
+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:8
@@ -38,7 +38,7 @@
Returns void
+Defined in src/pools/worker.ts:24
+Defined in src/pools/pool.ts:54
+Defined in src/pools/pool.ts:33
@@ -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:42
+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: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:108
Whether worker nodes are executing at least one task.
+Whether worker nodes are executing concurrently their tasks quota or not.
Returns boolean
Worker nodes busyness boolean status.
+ProtectedAbstractis@@ -914,7 +914,7 @@ Can be overridden.
Returns boolean
Privateredistribute@@ -927,7 +927,7 @@ Can be overridden.
workerNodeKey: number