From 3abeb14de6a5845deeb027ccc69c3feeec8f4a3a Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Fri, 7 Jul 2023 06:45:07 +0000
Subject: [PATCH] chore: generate documentation
---
docs/classes/AbstractPool.html | 148 +++++++++---------
docs/classes/AbstractWorker.html | 54 +++----
docs/classes/CircularArray.html | 28 ++--
docs/classes/ClusterWorker.html | 40 ++---
docs/classes/DynamicClusterPool.html | 78 ++++-----
docs/classes/DynamicThreadPool.html | 78 ++++-----
docs/classes/FixedClusterPool.html | 76 ++++-----
docs/classes/FixedThreadPool.html | 76 ++++-----
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 | 26 +--
docs/interfaces/IWorker.html | 16 +-
docs/interfaces/IWorkerChoiceStrategy.html | 22 +--
docs/interfaces/MeasurementOptions.html | 10 +-
docs/interfaces/MeasurementStatistics.html | 20 +--
.../MeasurementStatisticsRequirements.html | 14 +-
docs/interfaces/MessageValue.html | 30 ++--
docs/interfaces/PoolInfo.html | 40 ++---
docs/interfaces/PoolOptions.html | 28 ++--
docs/interfaces/PromiseResponseWrapper.html | 14 +-
docs/interfaces/StrategyPolicy.html | 10 +-
docs/interfaces/Task.html | 16 +-
docs/interfaces/TaskError.html | 14 +-
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 | 14 +-
docs/interfaces/WorkerNode.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, 669 insertions(+), 669 deletions(-)
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index dd00795b..05e60478 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-AbstractPool | poolifier - v2.6.8
+AbstractPool | poolifier - v2.6.9
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:51
@@ -176,7 +176,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:96
Protected Readonly filePath
filePath: string
@@ -202,7 +202,7 @@
+
Defined in src/pools/abstract-pool.ts:98
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -210,7 +210,7 @@
+Defined in src/pools/abstract-pool.ts:97
Protected Readonly opts
@@ -218,7 +218,7 @@
+Defined in src/pools/abstract-pool.ts:99
Protected promiseResponseMap
@@ -231,7 +231,7 @@
+Defined in src/pools/abstract-pool.ts:70
Private Readonly startTimestamp
startTimestamp: number
@@ -239,7 +239,7 @@
+Defined in src/pools/abstract-pool.ts:87
Protected workerChoiceStrategyContext
@@ -247,7 +247,7 @@
+Defined in src/pools/abstract-pool.ts:78
Readonly workerNodes
@@ -256,7 +256,7 @@
+Defined in src/pools/abstract-pool.ts:57
Protected full
@@ -282,7 +282,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:521
+Defined in src/pools/abstract-pool.ts:252
Protected Abstract maxSize
@@ -305,7 +305,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:427
Protected Abstract minSize
@@ -316,7 +316,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:422
Protected Abstract type
@@ -328,7 +328,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:412
+Defined in src/pools/abstract-pool.ts:391
Protected Abstract worker
@@ -351,7 +351,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:417
Protected afterWorkerSetup
@@ -398,7 +398,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:869
Protected beforeTaskExecutionHook
@@ -423,7 +423,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:625
Private buildTasksQueueOptions
@@ -436,7 +436,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:508
Private checkAndEmitEvents
@@ -444,7 +444,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1028
Private checkFilePath
@@ -457,7 +457,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:135
Private checkNumberOfWorkers
@@ -470,7 +470,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:144
Private checkPoolOptions
@@ -483,7 +483,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:162
Private checkValidTasksQueueOptions
@@ -496,7 +496,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:227
Private checkValidWorkerChoiceStrategy
@@ -509,7 +509,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:189
Private checkValidWorkerChoiceStrategyOptions
@@ -522,7 +522,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:199
Private chooseWorkerNode
@@ -535,7 +535,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:811
Protected createAndSetupDynamicWorker
@@ -547,7 +547,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:947
Protected createAndSetupWorker
@@ -559,7 +559,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:879
Protected Abstract createWorker
@@ -571,7 +571,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:861
Private dequeueTask
@@ -584,7 +584,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1141
+Defined in src/pools/abstract-pool.ts:580
Protected Abstract destroyWorker
@@ -615,7 +615,7 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:601
+Defined in src/pools/abstract-pool.ts:486
Private enqueueTask
@@ -655,7 +655,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1137
+Defined in src/pools/abstract-pool.ts:546
Private executeTask
@@ -696,7 +696,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:1132
Private flushTasksQueue
@@ -709,7 +709,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1153
Private flushTasksQueues
@@ -717,7 +717,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1163
Private getInitialWorkerInfo
@@ -730,7 +730,7 @@ Can be overridden.
worker: Worker
+Defined in src/pools/abstract-pool.ts:1223
Private getInitialWorkerUsage
@@ -743,7 +743,7 @@ Can be overridden.
Optional worker: Worker
+Defined in src/pools/abstract-pool.ts:1181
Private getWorkerById
@@ -763,7 +763,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:435
Private getWorkerId
@@ -783,7 +783,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1087
Private getWorkerInfo
@@ -802,7 +802,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1057
Private getWorkerNodeKey
@@ -822,7 +822,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:446
Private handleTaskExecutionResponse
@@ -835,7 +835,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1001
Private handleWorkerStartedMessage
@@ -848,7 +848,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:986
Protected internalBusy
@@ -860,7 +860,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:537
Protected Abstract isMain
@@ -871,7 +871,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:616
Private pushWorkerNode
@@ -891,7 +891,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1067
Private redistributeQueuedTasks
@@ -904,7 +904,7 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:914
Private registerWorkerMessageListener
@@ -944,7 +944,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:849
Private removeWorkerNode
@@ -963,7 +963,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1124
Protected Abstract sendToWorker
@@ -987,7 +987,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:838
+Defined in src/pools/abstract-pool.ts:498
+Defined in src/pools/abstract-pool.ts:453
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:475
Private setWorkerNodeTasksUsage
@@ -1076,7 +1076,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1045
Private setWorkerStatistics
@@ -1089,7 +1089,7 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:1169
Protected setupHook
@@ -1101,7 +1101,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:609
Private shallCreateDynamicWorker
@@ -1113,7 +1113,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:828
Private tasksMaxQueueSize
@@ -1126,7 +1126,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1149
Private tasksQueueSize
@@ -1139,7 +1139,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1145
Private updateEluWorkerUsage
@@ -1154,7 +1154,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:740
Private updateRunTimeWorkerUsage
@@ -1169,7 +1169,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:664
Private updateTaskStatisticsWorkerUsage
@@ -1184,7 +1184,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:651
Private updateWaitTimeWorkerUsage
@@ -1199,7 +1199,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:702
Protected workerListener
@@ -1226,7 +1226,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:974
+
Defined in src/worker/abstract-worker.ts:58
Protected Abstract id
id: number
@@ -159,7 +159,7 @@
+Defined in src/worker/abstract-worker.ts:42
Protected Readonly isMain
isMain: boolean
@@ -167,7 +167,7 @@
+Defined in src/worker/abstract-worker.ts:70
Protected lastTaskTimestamp
lastTaskTimestamp: number
@@ -175,7 +175,7 @@
+Defined in src/worker/abstract-worker.ts:50
Protected Readonly mainWorker
mainWorker: MainWorker
@@ -183,7 +183,7 @@
+Defined in src/worker/abstract-worker.ts:74
Protected Readonly opts
@@ -191,7 +191,7 @@
+Defined in src/worker/abstract-worker.ts:75
Protected statistics
@@ -199,7 +199,7 @@
+Defined in src/worker/abstract-worker.ts:54
Protected taskFunctions
@@ -207,7 +207,7 @@
+Defined in src/worker/abstract-worker.ts:46
bind
@@ -266,7 +266,7 @@
Returns void
+Defined in src/worker/abstract-worker.ts:202
Private checkStatistics
@@ -274,7 +274,7 @@
-
Returns void
+Defined in src/worker/abstract-worker.ts:336
Private checkTaskFunctions
@@ -293,7 +293,7 @@
Returns void
+Defined in src/worker/abstract-worker.ts:107
Private checkWorkerOptions
Returns void
+Defined in src/worker/abstract-worker.ts:95
emitDestroy
@@ -335,7 +335,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:321
Protected getMainWorker
@@ -347,7 +347,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:183
Private getTaskFunction
@@ -366,7 +366,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:304
Protected handleError
@@ -386,7 +386,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:217
Protected messageListener
@@ -405,7 +405,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:147
Protected runAsync
@@ -429,7 +429,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:264
runInAsyncScope
@@ -508,7 +508,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:227
Protected Abstract sendToMainWorker
@@ -527,7 +527,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:195
Private startCheckAlive
@@ -535,7 +535,7 @@ then restore the original execution context.
-
Returns void
+Defined in src/worker/abstract-worker.ts:169
triggerAsyncId
@@ -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:183
+
Defined in src/worker/abstract-worker.ts:217
Protected messageListener
+
Defined in src/worker/abstract-worker.ts:147
+
Defined in src/worker/abstract-worker.ts:264
+
Defined in src/worker/abstract-worker.ts:227
Protected sendToMainWorker
+
Defined in src/worker/cluster-worker.ts:52
@@ -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
@@ -141,7 +141,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
@@ -159,7 +159,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:60
Protected Readonly filePath
filePath: string
@@ -168,7 +168,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:98
Protected Readonly max
max: number
@@ -176,7 +176,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
@@ -185,7 +185,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:97
Protected Readonly opts
@@ -194,7 +194,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/cluster/fixed.ts:52
Protected promiseResponseMap
@@ -208,7 +208,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:70
Protected workerChoiceStrategyContext
@@ -217,7 +217,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:78
Readonly workerNodes
@@ -226,7 +226,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:57
+
Defined in src/pools/abstract-pool.ts:521
+
Defined in src/pools/abstract-pool.ts:252
+
Defined in src/pools/cluster/dynamic.ts:42
+
Defined in src/pools/cluster/fixed.ts:97
+
Defined in src/pools/cluster/dynamic.ts:37
+
Defined in src/pools/abstract-pool.ts:391
+
Defined in src/pools/cluster/fixed.ts:92
Protected afterWorkerSetup
+
Defined in src/pools/abstract-pool.ts:869
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:625
Protected createAndSetupDynamicWorker
+
Defined in src/pools/abstract-pool.ts:947
Protected createAndSetupWorker
+
Defined in src/pools/abstract-pool.ts:879
+
Defined in src/pools/cluster/fixed.ts:82
+
Defined in src/pools/abstract-pool.ts:580
+
Defined in src/pools/cluster/fixed.ts:68
+
Defined in src/pools/abstract-pool.ts:486
+
Defined in src/pools/abstract-pool.ts:546
+
Defined in src/pools/abstract-pool.ts:537
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/cluster/fixed.ts:77
+
Defined in src/pools/abstract-pool.ts:498
+
Defined in src/pools/abstract-pool.ts:453
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:475
+
Defined in src/pools/cluster/fixed.ts:58
+Defined in src/pools/abstract-pool.ts:974
@@ -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
@@ -141,7 +141,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
@@ -159,7 +159,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:60
Protected Readonly filePath
filePath: string
@@ -168,7 +168,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:98
Protected Readonly max
max: number
@@ -176,7 +176,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
@@ -185,7 +185,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:97
Protected Readonly opts
@@ -194,7 +194,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/thread/fixed.ts:51
Protected promiseResponseMap
@@ -208,7 +208,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:70
Protected workerChoiceStrategyContext
@@ -217,7 +217,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:78
Readonly workerNodes
@@ -226,7 +226,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:57
Accessors
@@ -241,7 +241,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/thread/dynamic.ts:47
+
Defined in src/pools/abstract-pool.ts:521
+
Defined in src/pools/abstract-pool.ts:252
+
Defined in src/pools/thread/dynamic.ts:42
+
Defined in src/pools/thread/fixed.ts:91
+
Defined in src/pools/thread/dynamic.ts:37
+
Defined in src/pools/abstract-pool.ts:391
+
Defined in src/pools/thread/fixed.ts:86
Protected afterWorkerSetup
+
Defined in src/pools/abstract-pool.ts:869
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:625
Protected createAndSetupDynamicWorker
+
Defined in src/pools/abstract-pool.ts:947
Protected createAndSetupWorker
+
Defined in src/pools/abstract-pool.ts:879
+
Defined in src/pools/thread/fixed.ts:73
+
Defined in src/pools/abstract-pool.ts:580
+
Defined in src/pools/thread/fixed.ts:62
+
Defined in src/pools/abstract-pool.ts:486
+
Defined in src/pools/abstract-pool.ts:546
+
Defined in src/pools/abstract-pool.ts:537
+
Defined in src/pools/thread/fixed.ts:57
+
Defined in src/pools/thread/fixed.ts:68
+
Defined in src/pools/abstract-pool.ts:498
+
Defined in src/pools/abstract-pool.ts:453
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:475
+
Defined in src/pools/abstract-pool.ts:609
+Defined in src/pools/abstract-pool.ts:974
@@ -45,7 +45,7 @@
+
Defined in src/pools/cluster/fixed.ts:38
+
Defined in src/pools/cluster/fixed.ts:49
Protected Readonly filePath
filePath: string
@@ -162,7 +162,7 @@
+
Defined in src/pools/abstract-pool.ts:98
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -171,7 +171,7 @@
+
Defined in src/pools/abstract-pool.ts:97
Protected Readonly opts
@@ -180,7 +180,7 @@
+
Defined in src/pools/cluster/fixed.ts:52
Protected promiseResponseMap
@@ -194,7 +194,7 @@
+
Defined in src/pools/abstract-pool.ts:70
Protected workerChoiceStrategyContext
@@ -203,7 +203,7 @@
+
Defined in src/pools/abstract-pool.ts:78
Readonly workerNodes
@@ -212,7 +212,7 @@
+
Defined in src/pools/abstract-pool.ts:57
+
Defined in src/pools/abstract-pool.ts:521
+
Defined in src/pools/abstract-pool.ts:252
+
Defined in src/pools/cluster/fixed.ts:102
+
Defined in src/pools/cluster/fixed.ts:97
+
Defined in src/pools/cluster/fixed.ts:87
+
Defined in src/pools/abstract-pool.ts:391
+
Defined in src/pools/cluster/fixed.ts:92
Protected afterWorkerSetup
+
Defined in src/pools/abstract-pool.ts:869
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:625
Protected createAndSetupDynamicWorker
+
Defined in src/pools/abstract-pool.ts:947
Protected createAndSetupWorker
+
Defined in src/pools/abstract-pool.ts:879
+
Defined in src/pools/cluster/fixed.ts:82
+
Defined in src/pools/abstract-pool.ts:580
+
Defined in src/pools/cluster/fixed.ts:68
+
Defined in src/pools/abstract-pool.ts:486
+
Defined in src/pools/abstract-pool.ts:546
+
Defined in src/pools/abstract-pool.ts:537
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/cluster/fixed.ts:77
+
Defined in src/pools/abstract-pool.ts:498
+
Defined in src/pools/abstract-pool.ts:453
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:475
+
Defined in src/pools/cluster/fixed.ts:58
+
Defined in src/pools/abstract-pool.ts:974
@@ -45,7 +45,7 @@
+
Defined in src/pools/thread/fixed.ts:37
+
Defined in src/pools/thread/fixed.ts:48
Protected Readonly filePath
filePath: string
@@ -162,7 +162,7 @@
+
Defined in src/pools/abstract-pool.ts:98
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -171,7 +171,7 @@
+
Defined in src/pools/abstract-pool.ts:97
Protected Readonly opts
@@ -180,7 +180,7 @@
+
Defined in src/pools/thread/fixed.ts:51
Protected promiseResponseMap
@@ -194,7 +194,7 @@
+
Defined in src/pools/abstract-pool.ts:70
Protected workerChoiceStrategyContext
@@ -203,7 +203,7 @@
+
Defined in src/pools/abstract-pool.ts:78
Readonly workerNodes
@@ -212,7 +212,7 @@
+
Defined in src/pools/abstract-pool.ts:57
+
Defined in src/pools/abstract-pool.ts:521
+
Defined in src/pools/abstract-pool.ts:252
+
Defined in src/pools/thread/fixed.ts:96
+
Defined in src/pools/thread/fixed.ts:91
+
Defined in src/pools/thread/fixed.ts:81
+
Defined in src/pools/abstract-pool.ts:391
+
Defined in src/pools/thread/fixed.ts:86
Protected afterWorkerSetup
+
Defined in src/pools/abstract-pool.ts:869
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:625
Protected createAndSetupDynamicWorker
+
Defined in src/pools/abstract-pool.ts:947
Protected createAndSetupWorker
+
Defined in src/pools/abstract-pool.ts:879
+
Defined in src/pools/thread/fixed.ts:73
+
Defined in src/pools/abstract-pool.ts:580
+
Defined in src/pools/thread/fixed.ts:62
+
Defined in src/pools/abstract-pool.ts:486
+
Defined in src/pools/abstract-pool.ts:546
+
Defined in src/pools/abstract-pool.ts:537
+
Defined in src/pools/thread/fixed.ts:57
+
Defined in src/pools/thread/fixed.ts:68
+
Defined in src/pools/abstract-pool.ts:498
+
Defined in src/pools/abstract-pool.ts:453
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:475
+
Defined in src/pools/abstract-pool.ts:609
+
Defined in src/pools/abstract-pool.ts:974
@@ -26,7 +26,7 @@
+
Defined in src/pools/pool.ts:50
@@ -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/abstract-worker.ts:183
+
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:264
+
Defined in src/worker/abstract-worker.ts:227
Protected sendToMainWorker
+
Defined in src/worker/thread-worker.ts:56
@@ -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.8
+
poolifier - v2.6.9
Index
@@ -105,7 +105,7 @@
Theme
@@ -26,7 +26,7 @@
+
Defined in src/pools/cluster/fixed.ts:15
+
Defined in src/pools/pool.ts:156
Optional enableTasksQueue
enableTasksQueue?: boolean
@@ -70,7 +70,7 @@
+Defined in src/pools/pool.ts:162
+Defined in src/pools/cluster/fixed.ts:21
Optional errorHandler
@@ -89,7 +89,7 @@
+Defined in src/pools/pool.ts:128
Optional exitHandler
@@ -98,7 +98,7 @@
+Defined in src/pools/pool.ts:136
Optional messageHandler
@@ -107,7 +107,7 @@
+Defined in src/pools/pool.ts:124
Optional onlineHandler
@@ -116,7 +116,7 @@
+Defined in src/pools/pool.ts:132
Optional restartWorkerOnError
restartWorkerOnError?: boolean
@@ -125,7 +125,7 @@
+Defined in src/pools/pool.ts:150
+Defined in src/pools/cluster/fixed.ts:27
Optional tasksQueueOptions
@@ -144,7 +144,7 @@
+Defined in src/pools/pool.ts:166
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:142
Optional workerChoiceStrategyOptions
@@ -164,7 +164,7 @@
+Defined in src/pools/pool.ts:146
@@ -24,7 +24,7 @@
- EventLoopUtilizationMeasurementStatistics
+
Defined in src/pools/worker.ts:95
+
Defined in src/pools/worker.ts:96
Optional utilization
utilization?: number
+
Defined in src/pools/worker.ts:98
@@ -46,7 +46,7 @@
+
Defined in src/pools/pool.ts:176
@@ -81,7 +81,7 @@
Returns Promise<void>
+
Defined in src/pools/pool.ts:211
Optional Readonly emitter
@@ -96,7 +96,7 @@
+Defined in src/pools/pool.ts:199
enableTasksQueue
enableTasksQueue: ((enable, tasksQueueOptions?) => void)
@@ -125,7 +125,7 @@
Returns void
+Defined in src/pools/pool.ts:236
execute
execute: ((data?, name?) => Promise<Response>)
@@ -155,7 +155,7 @@
+Defined in src/pools/pool.ts:207
Readonly info
@@ -163,7 +163,7 @@
+Defined in src/pools/pool.ts:184
setTasksQueueOptions
setTasksQueueOptions: ((tasksQueueOptions) => void)
@@ -187,7 +187,7 @@
Returns void
+Defined in src/pools/pool.ts:245
setWorkerChoiceStrategy
setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
@@ -216,7 +216,7 @@
Returns void
+Defined in src/pools/pool.ts:218
setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
@@ -240,7 +240,7 @@
Returns void
+Defined in src/pools/pool.ts:227
Readonly workerNodes
@@ -248,7 +248,7 @@
+Defined in src/pools/pool.ts:188
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:176
+
Defined in src/pools/worker.ts:180
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:188
once
once: ((event, handler) => void)
@@ -147,12 +147,12 @@
Returns void
+Defined in src/pools/worker.ts:198
Optional Readonly threadId
threadId?: number
+Defined in src/pools/worker.ts:181
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:184
remove
remove: ((workerNodeKey) => boolean)
@@ -83,7 +83,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:191
reset
reset: (() => boolean)
@@ -100,7 +100,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:172
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
update
update: ((workerNodeKey) => boolean)
@@ -162,7 +162,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:178
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:65
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:63
+
Defined in src/pools/worker.ts:67
Optional average
average?: number
@@ -56,7 +56,7 @@
+Defined in src/pools/worker.ts:79
Readonly history
@@ -64,7 +64,7 @@
+Defined in src/pools/worker.ts:87
Optional maximum
maximum?: number
@@ -72,7 +72,7 @@
+Defined in src/pools/worker.ts:75
Optional median
median?: number
@@ -80,7 +80,7 @@
+Defined in src/pools/worker.ts:83
Optional minimum
minimum?: number
@@ -88,7 +88,7 @@
+Defined in src/pools/worker.ts:71
+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:62
Optional Readonly dynamic
dynamic?: boolean
@@ -77,7 +77,7 @@
+
Defined in src/utility-types.ts:91
Optional Readonly id
id?: string
@@ -86,7 +86,7 @@
+
Defined in src/pools/worker.ts:55
Optional Readonly kill
kill?: 1 | "SOFT" | "HARD"
@@ -94,7 +94,7 @@
+Defined in src/utility-types.ts:71
Optional Readonly name
name?: string
@@ -103,7 +103,7 @@
+Defined in src/pools/worker.ts:43
Optional Readonly started
started?: boolean
@@ -111,7 +111,7 @@
+Defined in src/utility-types.ts:87
Optional Readonly statistics
@@ -119,7 +119,7 @@
+Defined in src/utility-types.ts:83
Optional Readonly taskError
@@ -127,7 +127,7 @@
+Defined in src/utility-types.ts:75
Optional Readonly taskPerformance
@@ -135,7 +135,7 @@
+Defined in src/utility-types.ts:79
Optional Readonly timestamp
timestamp?: number
@@ -144,7 +144,7 @@
+Defined in src/pools/worker.ts:51
Optional Readonly workerId
workerId?: number
@@ -152,7 +152,7 @@
+Defined in src/utility-types.ts:67
@@ -24,7 +24,7 @@
+
Defined in src/pools/pool.ts:70
+
Defined in src/pools/pool.ts:83
executedTasks
executedTasks: number
+
Defined in src/pools/pool.ts:84
executingTasks
executingTasks: number
+
Defined in src/pools/pool.ts:85
failedTasks
failedTasks: number
+
Defined in src/pools/pool.ts:88
idleWorkerNodes
idleWorkerNodes: number
@@ -81,27 +81,27 @@
+Defined in src/pools/pool.ts:81
maxQueuedTasks
maxQueuedTasks: number
+Defined in src/pools/pool.ts:87
+Defined in src/pools/pool.ts:75
+Defined in src/pools/pool.ts:74
queuedTasks
queuedTasks: number
+Defined in src/pools/pool.ts:86
Optional runTime
runTime?: {
    average: number;
    maximum: number;
    median?: number;
    minimum: number;
}
@@ -117,12 +117,12 @@
minimum: number
+Defined in src/pools/pool.ts:89
type
type: "fixed" | "dynamic"
+Defined in src/pools/pool.ts:72
Optional utilization
utilization?: number
@@ -130,12 +130,12 @@
+Defined in src/pools/pool.ts:77
+Defined in src/pools/pool.ts:71
Optional waitTime
waitTime?: {
    average: number;
    maximum: number;
    median?: number;
    minimum: number;
}
@@ -151,12 +151,12 @@
minimum: number
+Defined in src/pools/pool.ts:95
worker
worker: "cluster" | "thread"
+Defined in src/pools/pool.ts:73
workerNodes
workerNodes: number
@@ -164,7 +164,7 @@
+Defined in src/pools/pool.ts:79
@@ -35,7 +35,7 @@
ClusterPoolOptions
ThreadPoolOptions
+
Defined in src/pools/pool.ts:120
@@ -65,7 +65,7 @@
Default Value
true
+
Defined in src/pools/pool.ts:156
Optional enableTasksQueue
enableTasksQueue?: boolean
@@ -75,7 +75,7 @@
Default Value
false
+Defined in src/pools/pool.ts:162
Optional errorHandler
@@ -83,7 +83,7 @@
+Defined in src/pools/pool.ts:128
Optional exitHandler
@@ -91,7 +91,7 @@
+Defined in src/pools/pool.ts:136
Optional messageHandler
@@ -99,7 +99,7 @@
+Defined in src/pools/pool.ts:124
Optional onlineHandler
@@ -107,7 +107,7 @@
+Defined in src/pools/pool.ts:132
Optional restartWorkerOnError
restartWorkerOnError?: boolean
@@ -115,7 +115,7 @@
+Defined in src/pools/pool.ts:150
Optional tasksQueueOptions
@@ -123,7 +123,7 @@
+Defined in src/pools/pool.ts:166
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:142
Optional workerChoiceStrategyOptions
@@ -141,7 +141,7 @@
+Defined in src/pools/pool.ts:146
@@ -37,7 +37,7 @@
+
Defined in src/utility-types.ts:101
@@ -71,7 +71,7 @@
Returns void
+
Defined in src/utility-types.ts:112
Readonly resolve
resolve: ((value) => void)
@@ -92,7 +92,7 @@
Returns void
+Defined in src/utility-types.ts:108
Readonly worker
worker: Worker
@@ -100,7 +100,7 @@
+Defined in src/utility-types.ts:116
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:152
@@ -34,7 +34,7 @@
+
Defined in src/pools/worker.ts:39
+
Defined in src/pools/worker.ts:47
Optional Readonly id
id?: string
@@ -64,7 +64,7 @@
+Defined in src/pools/worker.ts:55
Optional Readonly name
name?: string
@@ -72,7 +72,7 @@
+Defined in src/pools/worker.ts:43
Optional Readonly timestamp
timestamp?: number
@@ -80,7 +80,7 @@
+Defined in src/pools/worker.ts:51
@@ -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 workerId
workerId: number
@@ -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:42
Optional Readonly runTime
runTime?: number
@@ -53,7 +53,7 @@
+Defined in src/utility-types.ts:38
Readonly timestamp
timestamp: number
@@ -61,7 +61,7 @@
+Defined in src/utility-types.ts:34
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:106
+
Defined in src/pools/worker.ts:110
executing
executing: number
@@ -55,7 +55,7 @@
+Defined in src/pools/worker.ts:114
failed
failed: number
@@ -63,7 +63,7 @@
+Defined in src/pools/worker.ts:126
Readonly maxQueued
maxQueued: number
@@ -71,7 +71,7 @@
+Defined in src/pools/worker.ts:122
Readonly queued
queued: number
@@ -79,7 +79,7 @@
+Defined in src/pools/worker.ts:118
+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:106
@@ -45,7 +45,7 @@
Default Value
1
+Defined in src/pools/pool.ts:112
@@ -26,7 +26,7 @@
+
Defined in src/pools/thread/fixed.ts:20
+
Defined in src/pools/pool.ts:156
Optional enableTasksQueue
enableTasksQueue?: boolean
@@ -69,7 +69,7 @@
+Defined in src/pools/pool.ts:162
Optional errorHandler
@@ -78,7 +78,7 @@
+Defined in src/pools/pool.ts:128
Optional exitHandler
@@ -87,7 +87,7 @@
+Defined in src/pools/pool.ts:136
Optional messageHandler
@@ -96,7 +96,7 @@
+Defined in src/pools/pool.ts:124
Optional onlineHandler
@@ -105,7 +105,7 @@
+Defined in src/pools/pool.ts:132
Optional restartWorkerOnError
restartWorkerOnError?: boolean
@@ -114,7 +114,7 @@
+Defined in src/pools/pool.ts:150
Optional tasksQueueOptions
@@ -123,7 +123,7 @@
+Defined in src/pools/pool.ts:166
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:142
Optional workerChoiceStrategyOptions
@@ -143,7 +143,7 @@
+Defined in src/pools/pool.ts:146
+Defined in src/pools/thread/fixed.ts:26
@@ -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:134
+
Defined in src/pools/worker.ts:142
Readonly id
id: undefined | number
@@ -53,7 +53,7 @@
+Defined in src/pools/worker.ts:138
started
started: boolean
@@ -61,7 +61,7 @@
+Defined in src/pools/worker.ts:146
@@ -37,7 +37,7 @@
+
Defined in src/pools/worker.ts:208
+
Defined in src/pools/worker.ts:216
Readonly tasksQueue
@@ -67,7 +67,7 @@
+Defined in src/pools/worker.ts:224
+Defined in src/pools/worker.ts:220
Readonly worker
worker: Worker
@@ -83,7 +83,7 @@
+Defined in src/pools/worker.ts:212
@@ -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:154
+
Defined in src/pools/worker.ts:170
Readonly runTime
@@ -54,7 +54,7 @@
+Defined in src/pools/worker.ts:162
Readonly tasks
@@ -62,7 +62,7 @@
+Defined in src/pools/worker.ts:158
Readonly waitTime
@@ -70,7 +70,7 @@
+Defined in src/pools/worker.ts:166
@@ -40,7 +40,7 @@
Returns void
+Defined in src/pools/worker.ts:15
@@ -40,7 +40,7 @@
Returns void
+Defined in src/pools/worker.ts:28
+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:7
@@ -38,7 +38,7 @@
Returns void
+Defined in src/pools/worker.ts:23
+Defined in src/pools/pool.ts:65
+Defined in src/pools/pool.ts:32
@@ -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/pool.ts:45
+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
@@ -31,7 +31,7 @@
Readonly taskError: "taskError"
+Defined in src/pools/pool.ts:55
+Defined in src/pools/pool.ts:18
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
@@ -27,7 +27,7 @@
Readonly thread: "thread"
+Defined in src/pools/pool.ts:37