From c11be5eddc7229e4b77105ed27e93697b65d0146 Mon Sep 17 00:00:00 2001
From: Documentation Bot
Date: Sat, 23 Sep 2023 12:12:45 +0000
Subject: [PATCH] docs: generate documentation
---
docs/classes/AbstractPool.html | 198 +++++++++---------
docs/classes/AbstractWorker.html | 90 ++++----
docs/classes/CircularArray.html | 28 +--
docs/classes/ClusterWorker.html | 68 +++---
docs/classes/Deque.html | 38 ++--
docs/classes/DynamicClusterPool.html | 108 +++++-----
docs/classes/DynamicThreadPool.html | 108 +++++-----
docs/classes/FixedClusterPool.html | 108 +++++-----
docs/classes/FixedThreadPool.html | 108 +++++-----
docs/classes/Node.html | 16 +-
docs/classes/PoolEmitter.html | 64 +++---
docs/classes/ThreadWorker.html | 70 +++----
docs/classes/WorkerChoiceStrategyContext.html | 32 +--
docs/functions/availableParallelism.html | 8 +-
docs/index.html | 8 +-
docs/interfaces/ClusterPoolOptions.html | 34 +--
...tLoopUtilizationMeasurementStatistics.html | 14 +-
docs/interfaces/IPool.html | 40 ++--
docs/interfaces/IWorker.html | 16 +-
docs/interfaces/IWorkerChoiceStrategy.html | 25 +--
docs/interfaces/IWorkerNode.html | 46 ++--
docs/interfaces/MeasurementOptions.html | 10 +-
docs/interfaces/MeasurementStatistics.html | 20 +-
.../MeasurementStatisticsRequirements.html | 14 +-
docs/interfaces/MessageValue.html | 44 ++--
docs/interfaces/PoolInfo.html | 50 ++---
docs/interfaces/PoolOptions.html | 30 +--
docs/interfaces/PromiseResponseWrapper.html | 14 +-
docs/interfaces/StrategyData.html | 10 +-
docs/interfaces/StrategyPolicy.html | 12 +-
docs/interfaces/Task.html | 20 +-
.../TaskFunctionOperationResult.html | 12 +-
docs/interfaces/TaskPerformance.html | 16 +-
docs/interfaces/TaskStatistics.html | 20 +-
.../TaskStatisticsRequirements.html | 14 +-
docs/interfaces/TasksQueueOptions.html | 16 +-
docs/interfaces/ThreadPoolOptions.html | 32 +--
.../WorkerChoiceStrategyOptions.html | 20 +-
docs/interfaces/WorkerError.html | 14 +-
docs/interfaces/WorkerInfo.html | 18 +-
docs/interfaces/WorkerOptions.html | 16 +-
docs/interfaces/WorkerStatistics.html | 12 +-
docs/interfaces/WorkerUsage.html | 16 +-
docs/types/ErrorHandler.html | 8 +-
docs/types/ExitHandler.html | 8 +-
docs/types/KillBehavior.html | 8 +-
docs/types/KillHandler.html | 8 +-
docs/types/Measurement.html | 8 +-
docs/types/MessageHandler.html | 8 +-
docs/types/OnlineHandler.html | 8 +-
docs/types/PoolEvent.html | 8 +-
docs/types/PoolType.html | 8 +-
docs/types/TaskAsyncFunction.html | 8 +-
docs/types/TaskFunction.html | 8 +-
docs/types/TaskFunctions.html | 8 +-
docs/types/TaskSyncFunction.html | 8 +-
docs/types/WorkerChoiceStrategy.html | 8 +-
docs/types/WorkerNodeEventCallback.html | 8 +-
docs/types/WorkerType.html | 8 +-
docs/types/Writable.html | 8 +-
docs/variables/KillBehaviors.html | 8 +-
docs/variables/Measurements.html | 8 +-
docs/variables/PoolEvents.html | 8 +-
docs/variables/PoolTypes.html | 8 +-
docs/variables/WorkerChoiceStrategies.html | 8 +-
docs/variables/WorkerTypes.html | 8 +-
66 files changed, 921 insertions(+), 920 deletions(-)
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 905e085b..2ce0d073 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-AbstractPool | poolifier - v2.7.1
+AbstractPool | poolifier - v2.7.2
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:64
@@ -201,7 +201,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:126
Protected
Readonly
filePath
filePath: string
@@ -230,7 +230,7 @@
+
Defined in src/pools/abstract-pool.ts:128
Protected
Optional
Readonly
max
max?: number
@@ -238,7 +238,7 @@
+Defined in src/pools/abstract-pool.ts:97
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -246,7 +246,7 @@
+Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -254,7 +254,7 @@
+Defined in src/pools/abstract-pool.ts:129
Protected
promiseResponseMap
@@ -267,7 +267,7 @@
+Defined in src/pools/abstract-pool.ts:82
Private
Readonly
startTimestamp
startTimestamp: number
@@ -275,7 +275,7 @@
+Defined in src/pools/abstract-pool.ts:117
Private
started
started: boolean
@@ -283,7 +283,7 @@
+Defined in src/pools/abstract-pool.ts:109
Private
starting
starting: boolean
@@ -291,7 +291,7 @@
+Defined in src/pools/abstract-pool.ts:113
Private
Readonly
taskFunctions
@@ -303,7 +303,7 @@
+Defined in src/pools/abstract-pool.ts:104
Protected
workerChoiceStrategyContext
@@ -311,7 +311,7 @@
+Defined in src/pools/abstract-pool.ts:88
Readonly
Internal
workerNodes
@@ -320,7 +320,7 @@
+Defined in src/pools/abstract-pool.ts:70
Protected
full
@@ -346,7 +346,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:645
+Defined in src/pools/abstract-pool.ts:265
Protected
maxSize
@@ -369,7 +369,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:478
Protected
minSize
@@ -380,7 +380,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:471
Private
ready
@@ -391,7 +391,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:423
Protected
Abstract
type
@@ -403,7 +403,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:461
+Defined in src/pools/abstract-pool.ts:440
Protected
Abstract
worker
@@ -426,7 +426,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:466
Methods
@@ -459,7 +459,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/abstract-pool.ts:790
+Defined in src/pools/abstract-pool.ts:1587
Protected
afterTaskExecutionHook
@@ -506,7 +506,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1026
Protected
afterWorkerNodeSetup
@@ -526,7 +526,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1337
Protected
beforeTaskExecutionHook
@@ -551,7 +551,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:996
Private
buildTasksQueueOptions
@@ -564,7 +564,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:594
Private
checkAndEmitDynamicWorkerCreationEvents
@@ -572,7 +572,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1562
Private
checkAndEmitTaskExecutionEvents
@@ -580,7 +580,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1550
Private
checkAndEmitTaskQueuingEvents
@@ -588,7 +588,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1556
Private
checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:488
Private
checkNumberOfWorkers
@@ -622,7 +622,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:170
Private
checkPoolOptions
@@ -635,7 +635,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:188
Private
checkValidWorkerChoiceStrategyOptions
@@ -648,7 +648,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:217
Private
chooseWorkerNode
@@ -661,7 +661,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1153
Protected
createAndSetupDynamicWorkerNode
@@ -673,7 +673,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1243
Protected
createAndSetupWorkerNode
@@ -685,7 +685,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1199
Protected
Abstract
createWorker
@@ -697,7 +697,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1192
Private
deleteTaskFunctionWorkerUsages
@@ -710,7 +710,7 @@ Can be overridden.
name: string
Returns void
+Defined in src/pools/abstract-pool.ts:849
Private
dequeueTask
@@ -723,7 +723,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1652
Protected
Abstract
deregisterWorkerMessageListener
@@ -763,7 +763,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1324
+Defined in src/pools/abstract-pool.ts:934
Protected
Abstract
destroyWorkerNode
@@ -794,7 +794,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:972
+Defined in src/pools/abstract-pool.ts:559
Private
enqueueTask
@@ -834,7 +834,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1646
+Defined in src/pools/abstract-pool.ts:864
Private
executeTask
@@ -889,7 +889,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1640
Protected
flushTasksQueue
@@ -902,7 +902,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1660
Private
flushTasksQueues
@@ -910,7 +910,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1670
Protected
getWorkerInfo
@@ -930,7 +930,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1576
Private
getWorkerNodeKeyByWorker
@@ -950,7 +950,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:507
Private
getWorkerNodeKeyByWorkerId
@@ -970,7 +970,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:519
Private
handleTaskExecutionResponse
@@ -983,7 +983,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1522
Private
handleWorkerReadyResponse
@@ -996,7 +996,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1506
Private
hasBackPressure
@@ -1004,7 +1004,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1625
+Defined in src/pools/abstract-pool.ts:777
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1618
Protected
internalBusy
@@ -1058,7 +1058,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:661
Protected
Abstract
isMain
@@ -1069,7 +1069,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:987
+Defined in src/pools/abstract-pool.ts:829
Private
redistributeQueuedTasks
@@ -1095,7 +1095,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1380
Protected
Abstract
registerOnceWorkerMessageListener
@@ -1135,7 +1135,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1311
Protected
Abstract
registerWorkerMessageListener
@@ -1175,7 +1175,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1298
+Defined in src/pools/abstract-pool.ts:813
Private
removeWorkerNode
@@ -1215,7 +1215,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1609
Protected
sendKillMessageToWorker
@@ -1228,7 +1228,7 @@ Can be overridden.
workerNodeKey: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:944
Protected
Abstract
sendStartupMessageToWorker
@@ -1247,7 +1247,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1361
Private
sendStatisticsMessageToWorker
@@ -1266,7 +1266,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1368
Private
sendTaskFunctionOperationToWorker
@@ -1281,7 +1281,7 @@ Can be overridden.
Returns Promise<boolean>
+Defined in src/pools/abstract-pool.ts:680
Private
sendTaskFunctionOperationToWorkers
@@ -1294,7 +1294,7 @@ Can be overridden.
Returns Promise<boolean>
+Defined in src/pools/abstract-pool.ts:721
Protected
Abstract
sendToWorker
@@ -1323,7 +1323,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1181
+Defined in src/pools/abstract-pool.ts:842
Private
setTaskStealing
@@ -1352,7 +1352,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:614
+Defined in src/pools/abstract-pool.ts:573
Private
setTasksQueueSize
@@ -1385,7 +1385,7 @@ Can be overridden.
size: number
Returns void
+Defined in src/pools/abstract-pool.ts:608
Private
setTasksStealingOnBackPressure
@@ -1393,7 +1393,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:627
+Defined in src/pools/abstract-pool.ts:526
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:545
Protected
setupHook
@@ -1450,7 +1450,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:980
Private
shallCreateDynamicWorker
@@ -1462,7 +1462,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1170
Private
shallExecuteTask
@@ -1475,7 +1475,7 @@ Can be overridden.
workerNodeKey: number
Returns boolean
+Defined in src/pools/abstract-pool.ts:855
Private
shallUpdateTaskFunctionWorkerUsage
@@ -1495,7 +1495,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1059
+Defined in src/pools/abstract-pool.ts:918
Private
taskStealingOnEmptyQueue
@@ -1520,7 +1520,7 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1420
Private
tasksQueueSize
@@ -1533,7 +1533,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1656
Private
tasksStealingOnBackPressure
@@ -1546,7 +1546,7 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1448
Private
unsetTaskStealing
@@ -1554,7 +1554,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:621
Private
unsetTasksStealingOnBackPressure
@@ -1562,7 +1562,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:634
Private
updateEluWorkerUsage
@@ -1577,7 +1577,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1113
Private
updateRunTimeWorkerUsage
@@ -1592,7 +1592,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1086
Private
updateTaskStatisticsWorkerUsage
@@ -1607,7 +1607,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1068
Private
updateTaskStolenStatisticsWorkerUsage
@@ -1622,7 +1622,7 @@ Can be overridden.
taskName: string
Returns void
+Defined in src/pools/abstract-pool.ts:1401
Private
updateWaitTimeWorkerUsage
@@ -1637,7 +1637,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:1100
Protected
workerListener
@@ -1664,7 +1664,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1488
+
Defined in src/worker/abstract-worker.ts:79
Protected
Abstract
id
id: number
@@ -171,7 +171,7 @@
+Defined in src/worker/abstract-worker.ts:63
Protected
Readonly
isMain
isMain: boolean
@@ -179,7 +179,7 @@
+Defined in src/worker/abstract-worker.ts:91
Protected
lastTaskTimestamp
lastTaskTimestamp: number
@@ -187,7 +187,7 @@
+Defined in src/worker/abstract-worker.ts:71
Private
Readonly
mainWorker
mainWorker: MainWorker
@@ -195,7 +195,7 @@
+Defined in src/worker/abstract-worker.ts:92
Protected
opts
@@ -203,7 +203,7 @@
+Defined in src/worker/abstract-worker.ts:94
Protected
statistics
@@ -211,7 +211,7 @@
+Defined in src/worker/abstract-worker.ts:75
Protected
taskFunctions
@@ -219,7 +219,7 @@
+Defined in src/worker/abstract-worker.ts:67
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:307
Private
beginTaskPerformance
@@ -271,7 +271,7 @@ If a task function with the same name already exists, it is replaced.
Optional
name: string
+Defined in src/worker/abstract-worker.ts:587
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:284
Private
checkActive
@@ -309,7 +309,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:439
Private
checkMessageWorkerId
+Defined in src/worker/abstract-worker.ts:405
Private
checkStatistics
@@ -338,7 +338,7 @@ If a task function with the same name already exists, it is replaced.
-
Returns void
+Defined in src/worker/abstract-worker.ts:611
Private
checkTaskFunctions
@@ -357,7 +357,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:118
Private
checkWorkerOptions
@@ -370,7 +370,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:108
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:303
Private
endTaskPerformance
@@ -399,7 +399,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:596
+Defined in src/worker/abstract-worker.ts:454
Protected
handleError
@@ -433,7 +433,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:485
Protected
handleKillMessage
@@ -452,7 +452,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:371
Protected
Abstract
handleReadyMessage
@@ -471,7 +471,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:299
Protected
handleTaskFunctionOperationMessage
@@ -484,7 +484,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:326
hasTaskFunction
@@ -504,7 +504,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:162
listTaskFunctionNames
@@ -516,7 +516,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:243
Protected
messageListener
@@ -535,7 +535,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:306
removeTaskFunction
@@ -555,7 +555,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:214
Protected
run
@@ -574,7 +574,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:494
Protected
runAsync
@@ -598,7 +598,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:555
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:295
Protected
runSync
@@ -677,7 +677,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:521
Protected
sendTaskFunctionNamesToMainWorker
@@ -688,7 +688,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:473
Protected
Abstract
sendToMainWorker
@@ -707,7 +707,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:466
setDefaultTaskFunction
@@ -727,7 +727,7 @@ then restore the original execution context.
+Defined in src/worker/abstract-worker.ts:270
Private
startCheckActive
@@ -738,7 +738,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:418
Private
stopCheckActive
@@ -749,7 +749,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:429
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:312
Private
updateLastTaskTimestamp
@@ -768,7 +768,7 @@ then restore the original execution context.
-
Returns void
+Defined in src/worker/abstract-worker.ts:617
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:278
@@ -31,7 +31,7 @@
+
Defined in src/circular-array.ts:10
+
Defined in src/circular-array.ts:13
Properties
@@ -153,7 +153,7 @@ when they will be absent when used in a 'with' statement.
size
size: number
+Defined in src/circular-array.ts:11
Static
Readonly
[species]
[species]: ArrayConstructor
Returns void
+
Defined in src/circular-array.ts:100
concat
@@ -222,7 +222,7 @@ when they will be absent when used in a 'with' statement.
Inherit Doc
+Defined in src/circular-array.ts:41
copyWithin
@@ -263,7 +263,7 @@ is treated as length+end.
-
Returns boolean
+Defined in src/circular-array.ts:92
entries
@@ -729,7 +729,7 @@ thisArg is omitted, undefined is used as the this value.
-
Returns boolean
+Defined in src/circular-array.ts:96
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:23
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:80
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:56
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:32
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
@@ -128,7 +128,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/cluster-worker.ts:31
Protected
Readonly
isMain
isMain: boolean
@@ -148,7 +148,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:91
Protected
lastTaskTimestamp
lastTaskTimestamp: number
@@ -157,7 +157,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:71
Protected
opts
@@ -166,7 +166,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:94
Protected
statistics
@@ -175,7 +175,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:75
Protected
taskFunctions
@@ -184,7 +184,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:67
Accessors
@@ -198,7 +198,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/cluster-worker.ts:63
+
Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:307
bind
@@ -265,7 +265,7 @@ If a task function with the same name already exists, it is replaced.
+
Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:284
+
Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:303
Protected
getMainWorker
@@ -296,7 +296,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:454
+Defined in src/worker/abstract-worker.ts:485
Protected
handleKillMessage
+Defined in src/worker/abstract-worker.ts:371
Protected
handleReadyMessage
+Defined in src/worker/cluster-worker.ts:45
Protected
handleTaskFunctionOperationMessage
+Defined in src/worker/abstract-worker.ts:326
+Defined in src/worker/abstract-worker.ts:162
+Defined in src/worker/abstract-worker.ts:243
Protected
messageListener
+Defined in src/worker/abstract-worker.ts:306
+Defined in src/worker/abstract-worker.ts:214
+Defined in src/worker/abstract-worker.ts:494
+Defined in src/worker/abstract-worker.ts:555
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:295
+Defined in src/worker/abstract-worker.ts:521
Protected
sendTaskFunctionNamesToMainWorker
+Defined in src/worker/abstract-worker.ts:473
Protected
sendToMainWorker
+Defined in src/worker/cluster-worker.ts:68
+Defined in src/worker/abstract-worker.ts:270
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:312
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:278
@@ -33,7 +33,7 @@ Implemented with a doubly linked list.
+
Defined in src/deque.ts:26
@@ -77,14 +77,14 @@ Implemented with a doubly linked list.
T
Returns Deque<T>
+
Defined in src/deque.ts:34
maxSize
maxSize: number
@@ -92,7 +92,7 @@ Implemented with a doubly linked list.
+
Defined in src/deque.ts:32
size
size: number
@@ -100,12 +100,12 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:30
+Defined in src/deque.ts:28
+Defined in src/deque.ts:170
clear
@@ -146,7 +146,7 @@ Implemented with a doubly linked list.
Returns void
+Defined in src/deque.ts:131
Private
incrementSize
@@ -154,7 +154,7 @@ Implemented with a doubly linked list.
-
Returns number
+Defined in src/deque.ts:194
peekFirst
@@ -166,7 +166,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:116
peekLast
@@ -178,7 +178,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:124
pop
@@ -190,7 +190,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:77
push
@@ -210,7 +210,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:44
shift
@@ -222,7 +222,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:97
unshift
@@ -242,7 +242,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:61
@@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/cluster/dynamic.ts:16
@@ -156,7 +156,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/cluster/dynamic.ts:28
Properties
@@ -177,7 +177,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:73
Protected
Readonly
filePath
filePath: string
@@ -186,7 +186,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:128
Protected
Readonly
max
max: number
@@ -195,7 +195,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/cluster/dynamic.ts:30
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -204,7 +204,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -213,7 +213,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
@@ -227,7 +227,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:82
Protected
workerChoiceStrategyContext
@@ -236,7 +236,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:88
Readonly
Internal
workerNodes
@@ -245,7 +245,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:70
+
Defined in src/pools/abstract-pool.ts:645
+
Defined in src/pools/abstract-pool.ts:265
+
Defined in src/pools/abstract-pool.ts:478
+
Defined in src/pools/abstract-pool.ts:471
+
Defined in src/pools/abstract-pool.ts:423
+
Defined in src/pools/cluster/dynamic.ts:39
+
Defined in src/pools/abstract-pool.ts:440
+
Defined in src/pools/cluster/fixed.ts:134
Protected
afterTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:1026
Protected
afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1337
Protected
beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:996
Protected
createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1243
Protected
createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1199
+
Defined in src/pools/cluster/fixed.ts:124
Protected
deregisterWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:116
+
Defined in src/pools/abstract-pool.ts:934
Protected
destroyWorkerNode
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:559
+
Defined in src/pools/abstract-pool.ts:864
Protected
flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1660
+
Defined in src/pools/abstract-pool.ts:1576
+
Defined in src/pools/abstract-pool.ts:777
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1618
+
Defined in src/pools/abstract-pool.ts:661
+
Defined in src/pools/cluster/fixed.ts:58
+
Defined in src/pools/abstract-pool.ts:829
Protected
registerOnceWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:108
Protected
registerWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:100
+
Defined in src/pools/abstract-pool.ts:813
Protected
sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:944
Protected
sendStartupMessageToWorker
+
Defined in src/pools/cluster/fixed.ts:93
+
Defined in src/pools/cluster/fixed.ts:82
+
Defined in src/pools/abstract-pool.ts:842
+
Defined in src/pools/abstract-pool.ts:573
+
Defined in src/pools/abstract-pool.ts:526
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:545
+
Defined in src/pools/cluster/fixed.ts:53
+
Defined in src/pools/abstract-pool.ts:918
+
Defined in src/pools/abstract-pool.ts:1488
@@ -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:16
@@ -156,7 +156,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/thread/dynamic.ts:28
Properties
@@ -177,7 +177,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:73
Protected
Readonly
filePath
filePath: string
@@ -186,7 +186,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:128
Protected
Readonly
max
max: number
@@ -195,7 +195,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/thread/dynamic.ts:30
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -204,7 +204,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -213,7 +213,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/thread/fixed.ts:49
Protected
promiseResponseMap
@@ -227,7 +227,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:82
Protected
workerChoiceStrategyContext
@@ -236,7 +236,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:88
Readonly
Internal
workerNodes
@@ -245,7 +245,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/abstract-pool.ts:70
Accessors
@@ -260,7 +260,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/thread/dynamic.ts:44
+
Defined in src/pools/abstract-pool.ts:645
+
Defined in src/pools/abstract-pool.ts:265
+
Defined in src/pools/abstract-pool.ts:478
+
Defined in src/pools/abstract-pool.ts:471
+
Defined in src/pools/abstract-pool.ts:423
+
Defined in src/pools/thread/dynamic.ts:39
+
Defined in src/pools/abstract-pool.ts:440
+
Defined in src/pools/thread/fixed.ts:149
Protected
afterTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:1026
Protected
afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1337
Protected
beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:996
Protected
createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1243
Protected
createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1199
+
Defined in src/pools/thread/fixed.ts:136
Protected
deregisterWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:126
+
Defined in src/pools/abstract-pool.ts:934
Protected
destroyWorkerNode
+
Defined in src/pools/thread/fixed.ts:60
+
Defined in src/pools/abstract-pool.ts:559
+
Defined in src/pools/abstract-pool.ts:864
Protected
flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1660
+
Defined in src/pools/abstract-pool.ts:1576
+
Defined in src/pools/abstract-pool.ts:777
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1618
+
Defined in src/pools/abstract-pool.ts:661
+
Defined in src/pools/thread/fixed.ts:55
+
Defined in src/pools/abstract-pool.ts:829
Protected
registerOnceWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:116
Protected
registerWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:106
+
Defined in src/pools/abstract-pool.ts:813
Protected
sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:944
Protected
sendStartupMessageToWorker
+
Defined in src/pools/thread/fixed.ts:91
+
Defined in src/pools/thread/fixed.ts:77
+
Defined in src/pools/abstract-pool.ts:842
+
Defined in src/pools/abstract-pool.ts:573
+
Defined in src/pools/abstract-pool.ts:526
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:545
+
Defined in src/pools/abstract-pool.ts:980
+
Defined in src/pools/abstract-pool.ts:918
+
Defined in src/pools/abstract-pool.ts:1488
@@ -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
@@ -181,7 +181,7 @@
+
Defined in src/pools/abstract-pool.ts:128
Protected
Optional
Readonly
max
max?: number
@@ -190,7 +190,7 @@
+
Defined in src/pools/abstract-pool.ts:97
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -199,7 +199,7 @@
+
Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -208,7 +208,7 @@
+
Defined in src/pools/cluster/fixed.ts:47
Protected
promiseResponseMap
@@ -222,7 +222,7 @@
+
Defined in src/pools/abstract-pool.ts:82
Protected
workerChoiceStrategyContext
@@ -231,7 +231,7 @@
+
Defined in src/pools/abstract-pool.ts:88
Readonly
Internal
workerNodes
@@ -240,7 +240,7 @@
+
Defined in src/pools/abstract-pool.ts:70
+
Defined in src/pools/abstract-pool.ts:645
+
Defined in src/pools/abstract-pool.ts:265
+
Defined in src/pools/abstract-pool.ts:478
+
Defined in src/pools/abstract-pool.ts:471
+
Defined in src/pools/abstract-pool.ts:423
+
Defined in src/pools/cluster/fixed.ts:129
+
Defined in src/pools/abstract-pool.ts:440
+
Defined in src/pools/cluster/fixed.ts:134
Protected
afterTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:1026
Protected
afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1337
Protected
beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:996
Protected
createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1243
Protected
createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1199
+
Defined in src/pools/cluster/fixed.ts:124
Protected
deregisterWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:116
+
Defined in src/pools/abstract-pool.ts:934
Protected
destroyWorkerNode
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:559
+
Defined in src/pools/abstract-pool.ts:864
Protected
flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1660
+
Defined in src/pools/abstract-pool.ts:1576
+
Defined in src/pools/abstract-pool.ts:777
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1618
+
Defined in src/pools/abstract-pool.ts:661
+
Defined in src/pools/cluster/fixed.ts:58
+
Defined in src/pools/abstract-pool.ts:829
Protected
registerOnceWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:108
Protected
registerWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:100
+
Defined in src/pools/abstract-pool.ts:813
Protected
sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:944
Protected
sendStartupMessageToWorker
+
Defined in src/pools/cluster/fixed.ts:93
+
Defined in src/pools/cluster/fixed.ts:82
+
Defined in src/pools/abstract-pool.ts:842
+
Defined in src/pools/abstract-pool.ts:573
+
Defined in src/pools/abstract-pool.ts:526
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:545
+
Defined in src/pools/cluster/fixed.ts:53
+
Defined in src/pools/abstract-pool.ts:918
+
Defined in src/pools/abstract-pool.ts:1488
@@ -45,7 +45,7 @@
+
Defined in src/pools/thread/fixed.ts:35
+
Defined in src/pools/thread/fixed.ts:46
Protected
Readonly
filePath
filePath: string
@@ -181,7 +181,7 @@
+
Defined in src/pools/abstract-pool.ts:128
Protected
Optional
Readonly
max
max?: number
@@ -190,7 +190,7 @@
+
Defined in src/pools/abstract-pool.ts:97
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -199,7 +199,7 @@
+
Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -208,7 +208,7 @@
+
Defined in src/pools/thread/fixed.ts:49
Protected
promiseResponseMap
@@ -222,7 +222,7 @@
+
Defined in src/pools/abstract-pool.ts:82
Protected
workerChoiceStrategyContext
@@ -231,7 +231,7 @@
+
Defined in src/pools/abstract-pool.ts:88
Readonly
Internal
workerNodes
@@ -240,7 +240,7 @@
+
Defined in src/pools/abstract-pool.ts:70
+
Defined in src/pools/abstract-pool.ts:645
+
Defined in src/pools/abstract-pool.ts:265
+
Defined in src/pools/abstract-pool.ts:478
+
Defined in src/pools/abstract-pool.ts:471
+
Defined in src/pools/abstract-pool.ts:423
+
Defined in src/pools/thread/fixed.ts:144
+
Defined in src/pools/abstract-pool.ts:440
+
Defined in src/pools/thread/fixed.ts:149
Protected
afterTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:1026
Protected
afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1337
Protected
beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:996
Protected
createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1243
Protected
createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1199
+
Defined in src/pools/thread/fixed.ts:136
Protected
deregisterWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:126
+
Defined in src/pools/abstract-pool.ts:934
Protected
destroyWorkerNode
+
Defined in src/pools/thread/fixed.ts:60
+
Defined in src/pools/abstract-pool.ts:559
+
Defined in src/pools/abstract-pool.ts:864
Protected
flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1660
+
Defined in src/pools/abstract-pool.ts:1576
+
Defined in src/pools/abstract-pool.ts:777
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1618
+
Defined in src/pools/abstract-pool.ts:661
+
Defined in src/pools/thread/fixed.ts:55
+
Defined in src/pools/abstract-pool.ts:829
Protected
registerOnceWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:116
Protected
registerWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:106
+
Defined in src/pools/abstract-pool.ts:813
Protected
sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:944
Protected
sendStartupMessageToWorker
+
Defined in src/pools/thread/fixed.ts:91
+
Defined in src/pools/thread/fixed.ts:77
+
Defined in src/pools/abstract-pool.ts:842
+
Defined in src/pools/abstract-pool.ts:573
+
Defined in src/pools/abstract-pool.ts:526
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:545
+
Defined in src/pools/abstract-pool.ts:980
+
Defined in src/pools/abstract-pool.ts:918
+
Defined in src/pools/abstract-pool.ts:1488
@@ -32,7 +32,7 @@
+
Defined in src/deque.ts:9
@@ -67,24 +67,24 @@
data: T
Returns Node<T>
+
Defined in src/deque.ts:14
+
Defined in src/deque.ts:11
+Defined in src/deque.ts:12
@@ -26,7 +26,7 @@
+
Defined in src/pools/pool.ts:40
+
Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:109
+
Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:390
Static
captureRejections
captureRejections: boolean
@@ -109,7 +109,7 @@
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:397
Static
defaultMaxListeners
defaultMaxListeners: number
@@ -140,7 +140,7 @@ Its name
property is set to 'MaxListenersExceededWarning&
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:434
Static
Readonly
errorMonitor
@@ -153,7 +153,7 @@ regular 'error'
listener is installed.
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:383
Methods
@@ -187,7 +187,7 @@ regular 'error'
listener is installed.
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:454
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:716
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:779
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:631
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:725
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:644
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:604
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:486
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:516
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:743
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:759
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:675
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:615
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:599
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:625
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:375
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:296
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:325
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:268
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:250
Static
once
once(emitter, eventName, options?): Promise<any[]>
@@ -844,7 +844,7 @@ special handling:
Returns Promise<any[]>
+
Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:190
Static
setMaxListeners
@@ -869,7 +869,7 @@ special handling:
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/events.d.ts:340
@@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:26
@@ -129,7 +129,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:40
Protected
Readonly
isMain
isMain: boolean
@@ -149,7 +149,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:91
Protected
lastTaskTimestamp
lastTaskTimestamp: number
@@ -158,7 +158,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:71
Protected
opts
@@ -167,7 +167,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:94
Private
port
port: MessagePort
@@ -175,7 +175,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:33
Protected
statistics
@@ -184,7 +184,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:75
Protected
taskFunctions
@@ -193,7 +193,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/abstract-worker.ts:67
Accessors
@@ -207,7 +207,7 @@ but the minimum number of workers will be guaranteed.
+
Defined in src/worker/thread-worker.ts:84
+
Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:307
bind
@@ -274,7 +274,7 @@ If a task function with the same name already exists, it is replaced.
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:284
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:303
+Defined in src/worker/abstract-worker.ts:454
+Defined in src/worker/thread-worker.ts:94
Protected
handleKillMessage
+Defined in src/worker/thread-worker.ts:77
Protected
handleReadyMessage
+Defined in src/worker/thread-worker.ts:54
Protected
handleTaskFunctionOperationMessage
+Defined in src/worker/abstract-worker.ts:326
+Defined in src/worker/abstract-worker.ts:162
+Defined in src/worker/abstract-worker.ts:243
Protected
messageListener
+Defined in src/worker/abstract-worker.ts:306
+Defined in src/worker/abstract-worker.ts:214
+Defined in src/worker/abstract-worker.ts:494
+Defined in src/worker/abstract-worker.ts:555
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:295
+Defined in src/worker/abstract-worker.ts:521
Protected
sendTaskFunctionNamesToMainWorker
+Defined in src/worker/abstract-worker.ts:473
Protected
sendToMainWorker
+Defined in src/worker/thread-worker.ts:89
+Defined in src/worker/abstract-worker.ts:270
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:312
+Defined in node_modules/.pnpm/@types+node@20.6.3/node_modules/@types/node/async_hooks.d.ts:278
+
Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:52
Private
retriesCount
retriesCount: number = 0
@@ -126,12 +126,12 @@
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:40
Private
Readonly
workerChoiceStrategies
workerChoiceStrategies: Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:32
Private
workerChoiceStrategy
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
@@ -139,7 +139,7 @@
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:51
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:119
getTaskStatisticsRequirements
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:132
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:200
setOptions
@@ -218,7 +218,7 @@
Returns void
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:213
setWorkerChoiceStrategy
@@ -237,7 +237,7 @@
Returns void
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:145
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:159
@@ -26,7 +26,7 @@ Always returns a value greater than zero.
+
Defined in src/utils.ts:51
-
poolifier - v2.7.1
+
poolifier - v2.7.2
Index
@@ -111,7 +111,7 @@
Theme
@@ -26,7 +26,7 @@
+
Defined in src/pools/cluster/fixed.ts:10
+
Defined in src/pools/pool.ts:186
Optional
enableTasksQueue
enableTasksQueue?: boolean
@@ -73,7 +73,7 @@
+Defined in src/pools/pool.ts:192
+Defined in src/pools/cluster/fixed.ts:16
Optional
errorHandler
@@ -94,7 +94,7 @@
+Defined in src/pools/pool.ts:154
Optional
exitHandler
@@ -105,7 +105,7 @@
+Defined in src/pools/pool.ts:160
Optional
messageHandler
@@ -116,7 +116,7 @@
+Defined in src/pools/pool.ts:148
Optional
onlineHandler
@@ -127,7 +127,7 @@
+Defined in src/pools/pool.ts:142
Optional
restartWorkerOnError
restartWorkerOnError?: boolean
@@ -136,7 +136,7 @@
+Defined in src/pools/pool.ts:180
+Defined in src/pools/cluster/fixed.ts:22
Optional
startWorkers
startWorkers?: boolean
@@ -158,7 +158,7 @@
+Defined in src/pools/pool.ts:166
Optional
tasksQueueOptions
@@ -167,7 +167,7 @@
+Defined in src/pools/pool.ts:196
Optional
workerChoiceStrategy
workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -179,7 +179,7 @@
+Defined in src/pools/pool.ts:172
Optional
workerChoiceStrategyOptions
@@ -188,7 +188,7 @@
+Defined in src/pools/pool.ts:176
@@ -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:206
+Defined in src/pools/pool.ts:281
Readonly
destroy
destroy: (() => Promise<void>)
@@ -123,7 +123,7 @@ If a task function with the same name already exists, it will be overwritten.Returns Promise<void>
+Defined in src/pools/pool.ts:263
Optional
Readonly
emitter
@@ -141,7 +141,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/pool.ts:242
Readonly
enableTasksQueue
enableTasksQueue: ((enable, tasksQueueOptions?) => void)
@@ -170,7 +170,7 @@ If a task function with the same name already exists, it will be overwritten.Returns void
+Defined in src/pools/pool.ts:329
Readonly
execute
execute: ((data?, name?, transferList?) => Promise<Response>)
@@ -205,7 +205,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/pool.ts:251
Readonly
hasTaskFunction
hasTaskFunction: ((name) => boolean)
@@ -230,7 +230,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/pool.ts:270
Readonly
hasWorkerNodeBackPressure
hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
@@ -255,7 +255,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/pool.ts:228
Readonly
info
@@ -263,7 +263,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/pool.ts:214
Readonly
listTaskFunctionNames
listTaskFunctionNames: (() => string[])
@@ -280,7 +280,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/pool.ts:297
Readonly
removeTaskFunction
removeTaskFunction: ((name) => Promise<boolean>)
@@ -305,7 +305,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/pool.ts:291
Readonly
setDefaultTaskFunction
setDefaultTaskFunction: ((name) => Promise<boolean>)
@@ -330,7 +330,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/pool.ts:304
Readonly
setTasksQueueOptions
setTasksQueueOptions: ((tasksQueueOptions) => void)
@@ -354,7 +354,7 @@ If a task function with the same name already exists, it will be overwritten.Returns void
+Defined in src/pools/pool.ts:338
Readonly
setWorkerChoiceStrategy
setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
@@ -383,7 +383,7 @@ If a task function with the same name already exists, it will be overwritten.Returns void
+Defined in src/pools/pool.ts:311
Readonly
setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
@@ -407,7 +407,7 @@ If a task function with the same name already exists, it will be overwritten.Returns void
+Defined in src/pools/pool.ts:320
Readonly
start
start: (() => void)
@@ -423,7 +423,7 @@ If a task function with the same name already exists, it will be overwritten.Returns void
+Defined in src/pools/pool.ts:259
Readonly
Internal
workerNodes
@@ -431,7 +431,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/pool.ts:220
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:186
+
Defined in src/pools/worker.ts:190
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:198
Readonly
once
once: ((event, handler) => void)
@@ -147,12 +147,12 @@
Returns void
+Defined in src/pools/worker.ts:208
Optional
Readonly
threadId
threadId?: number
+Defined in src/pools/worker.ts:191
@@ -24,7 +24,7 @@
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:168
@@ -53,13 +53,14 @@
(): undefined | number
Returns undefined | number
The worker node key or undefined
.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:196
Readonly
remove
remove: ((workerNodeKey) => boolean)
@@ -84,7 +85,7 @@ If the worker node is not eligible, undefined
is returned.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:203
Readonly
reset
reset: (() => boolean)
@@ -101,7 +102,7 @@ If the worker node is not eligible, undefined
is returned.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:182
Readonly
setOptions
setOptions: ((opts) => void)
@@ -125,7 +126,7 @@ If the worker node is not eligible, undefined
is returned.
Returns void
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:209
Readonly
strategyPolicy
@@ -133,7 +134,7 @@ If the worker node is not eligible, undefined
is returned.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:172
Readonly
taskStatisticsRequirements
@@ -141,7 +142,7 @@ If the worker node is not eligible, undefined
is returned.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:176
Readonly
update
update: ((workerNodeKey) => boolean)
@@ -163,7 +164,7 @@ If the worker node is not eligible, undefined
is returned.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:188
@@ -37,7 +37,7 @@
+
Defined in src/pools/worker.ts:226
@@ -82,7 +82,7 @@
Returns void
+
Defined in src/pools/worker.ts:296
Readonly
closeChannel
closeChannel: (() => void)
@@ -98,7 +98,7 @@
Returns void
+Defined in src/pools/worker.ts:310
Readonly
deleteTaskFunctionWorkerUsage
deleteTaskFunctionWorkerUsage: ((name) => boolean)
@@ -123,7 +123,7 @@
+Defined in src/pools/worker.ts:324
Readonly
dequeueTask
dequeueTask: (() => undefined | Task<Data>)
@@ -140,7 +140,7 @@
+Defined in src/pools/worker.ts:286
Readonly
enqueueTask
enqueueTask: ((task) => number)
@@ -165,7 +165,7 @@
+Defined in src/pools/worker.ts:273
Readonly
getTaskFunctionWorkerUsage
getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
@@ -190,7 +190,7 @@
+Defined in src/pools/worker.ts:317
Readonly
hasBackPressure
hasBackPressure: (() => boolean)
@@ -207,7 +207,7 @@
+Defined in src/pools/worker.ts:302
Readonly
info
@@ -215,7 +215,7 @@
+Defined in src/pools/worker.ts:234
Optional
Readonly
messageChannel
messageChannel?: MessageChannel
@@ -223,7 +223,7 @@
+Defined in src/pools/worker.ts:247
Optional
onBackPressure
@@ -231,7 +231,7 @@
+Defined in src/pools/worker.ts:256
Optional
onEmptyQueue
@@ -239,7 +239,7 @@
+Defined in src/pools/worker.ts:260
Readonly
popTask
popTask: (() => undefined | Task<Data>)
@@ -256,7 +256,7 @@
+Defined in src/pools/worker.ts:292
Readonly
resetUsage
resetUsage: (() => void)
@@ -272,7 +272,7 @@
Returns void
+Defined in src/pools/worker.ts:306
Optional
strategyData
@@ -281,7 +281,7 @@ This is used to store data that is specific to the worker choice strategy.
+Defined in src/pools/worker.ts:243
tasksQueueBackPressureSize
tasksQueueBackPressureSize: number
@@ -290,7 +290,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:252
Readonly
tasksQueueSize
tasksQueueSize: (() => number)
@@ -307,7 +307,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:266
Readonly
unshiftTask
unshiftTask: ((task) => number)
@@ -332,7 +332,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:280
Readonly
usage
@@ -340,7 +340,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:238
Readonly
worker
worker: Worker
@@ -348,7 +348,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:230
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:63
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:39
+
Defined in src/pools/worker.ts:43
Optional
average
average?: number
@@ -56,7 +56,7 @@
+Defined in src/pools/worker.ts:55
Readonly
history
@@ -64,7 +64,7 @@
+Defined in src/pools/worker.ts:63
Optional
maximum
maximum?: number
@@ -72,7 +72,7 @@
+Defined in src/pools/worker.ts:51
Optional
median
median?: number
@@ -80,7 +80,7 @@
+Defined in src/pools/worker.ts:59
Optional
minimum
minimum?: number
@@ -88,7 +88,7 @@
+Defined in src/pools/worker.ts:47
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:120
median
median: boolean
@@ -61,7 +61,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:124
@@ -39,7 +39,7 @@
+
Defined in src/utility-types.ts:105
+
Defined in src/utility-types.ts:153
Optional
Readonly
data
data?: Data
@@ -84,7 +84,7 @@
+
Defined in src/utility-types.ts:83
Optional
Readonly
kill
kill?: true | "success" | "SOFT" | "HARD" | "failure"
@@ -92,7 +92,7 @@
+Defined in src/utility-types.ts:110
Optional
Readonly
name
name?: string
@@ -101,7 +101,7 @@
+Defined in src/utility-types.ts:79
Optional
Readonly
port
port?: MessagePort
@@ -109,7 +109,7 @@
+Defined in src/utility-types.ts:157
Optional
Readonly
ready
ready?: boolean
@@ -117,7 +117,7 @@
+Defined in src/utility-types.ts:149
Optional
Readonly
statistics
@@ -125,7 +125,7 @@
+Defined in src/utility-types.ts:145
Optional
Readonly
taskFunction
taskFunction?: string
@@ -133,7 +133,7 @@
+Defined in src/utility-types.ts:133
Optional
Readonly
taskFunctionName
taskFunctionName?: string
@@ -141,7 +141,7 @@
+Defined in src/utility-types.ts:137
Optional
Readonly
taskFunctionNames
taskFunctionNames?: string[]
@@ -149,7 +149,7 @@
+Defined in src/utility-types.ts:141
Optional
Readonly
taskFunctionOperation
taskFunctionOperation?: "add" | "default" | "remove"
@@ -162,7 +162,7 @@
+Defined in src/utility-types.ts:125
Optional
Readonly
taskFunctionOperationStatus
taskFunctionOperationStatus?: boolean
@@ -170,7 +170,7 @@
+Defined in src/utility-types.ts:129
Optional
Readonly
taskId
taskId?: string
@@ -179,7 +179,7 @@
+Defined in src/utility-types.ts:95
Optional
Readonly
taskPerformance
@@ -187,7 +187,7 @@
+Defined in src/utility-types.ts:118
Optional
Readonly
timestamp
timestamp?: number
@@ -196,7 +196,7 @@
+Defined in src/utility-types.ts:91
Optional
Readonly
transferList
transferList?: TransferListItem[]
@@ -205,7 +205,7 @@
+Defined in src/utility-types.ts:87
Optional
Readonly
workerError
@@ -213,7 +213,7 @@
+Defined in src/utility-types.ts:114
Optional
Readonly
workerId
workerId?: number
@@ -222,7 +222,7 @@
+Defined in src/utility-types.ts:75
@@ -24,7 +24,7 @@
+
Defined in src/pools/pool.ts:63
@@ -60,7 +60,7 @@
Optional
Readonly
backPressure
backPressure?: boolean
+Defined in src/pools/pool.ts:84
Readonly
busyWorkerNodes
busyWorkerNodes: number
@@ -68,22 +68,22 @@
+
Defined in src/pools/pool.ts:79
Readonly
executedTasks
executedTasks: number
+
Defined in src/pools/pool.ts:80
Readonly
executingTasks
executingTasks: number
+
Defined in src/pools/pool.ts:81
Readonly
failedTasks
failedTasks: number
+
Defined in src/pools/pool.ts:86
Readonly
idleWorkerNodes
idleWorkerNodes: number
@@ -91,32 +91,32 @@
+Defined in src/pools/pool.ts:77
Optional
Readonly
maxQueuedTasks
maxQueuedTasks?: number
+Defined in src/pools/pool.ts:83
Readonly
maxSize
maxSize: number
+Defined in src/pools/pool.ts:71
Readonly
minSize
minSize: number
+Defined in src/pools/pool.ts:70
Optional
Readonly
queuedTasks
queuedTasks?: number
+Defined in src/pools/pool.ts:82
Readonly
ready
ready: boolean
+Defined in src/pools/pool.ts:68
Optional
Readonly
runTime
runTime?: {
    average?: number;
    maximum: number;
    median?: number;
    minimum: number;
}
@@ -132,27 +132,27 @@
Readonly
minimum: number
+Defined in src/pools/pool.ts:87
Readonly
started
started: boolean
+Defined in src/pools/pool.ts:67
Optional
Readonly
stolenTasks
stolenTasks?: number
+Defined in src/pools/pool.ts:85
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:69
Readonly
type
type: "fixed" | "dynamic"
+Defined in src/pools/pool.ts:65
Optional
Readonly
utilization
utilization?: number
@@ -160,12 +160,12 @@
+Defined in src/pools/pool.ts:73
Readonly
version
version: string
+Defined in src/pools/pool.ts:64
Optional
Readonly
waitTime
waitTime?: {
    average?: number;
    maximum: number;
    median?: number;
    minimum: number;
}
@@ -181,12 +181,12 @@
Readonly
minimum: number
+Defined in src/pools/pool.ts:93
Readonly
worker
worker: "thread" | "cluster"
+Defined in src/pools/pool.ts:66
Readonly
workerNodes
workerNodes: number
@@ -194,7 +194,7 @@
+Defined in src/pools/pool.ts:75
+
Defined in src/pools/pool.ts:186
Optional
enableTasksQueue
enableTasksQueue?: boolean
@@ -78,7 +78,7 @@
+Defined in src/pools/pool.ts:192
Optional
errorHandler
@@ -88,7 +88,7 @@
Default Value
() => {}
+Defined in src/pools/pool.ts:154
Optional
exitHandler
@@ -98,7 +98,7 @@
Default Value
() => {}
+Defined in src/pools/pool.ts:160
Optional
messageHandler
@@ -108,7 +108,7 @@
Default Value
() => {}
+Defined in src/pools/pool.ts:148
Optional
onlineHandler
@@ -118,7 +118,7 @@
Default Value
() => {}
+Defined in src/pools/pool.ts:142
Optional
restartWorkerOnError
restartWorkerOnError?: boolean
@@ -126,7 +126,7 @@
+Defined in src/pools/pool.ts:180
Optional
startWorkers
startWorkers?: boolean
@@ -137,7 +137,7 @@
+Defined in src/pools/pool.ts:166
Optional
tasksQueueOptions
@@ -145,7 +145,7 @@
+Defined in src/pools/pool.ts:196
Optional
workerChoiceStrategy
workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -156,7 +156,7 @@
+Defined in src/pools/pool.ts:172
Optional
workerChoiceStrategyOptions
@@ -164,7 +164,7 @@
+Defined in src/pools/pool.ts:176
@@ -32,7 +32,7 @@
+
Defined in src/utility-types.ts:166
@@ -66,7 +66,7 @@
Returns void
+
Defined in src/utility-types.ts:174
Readonly
resolve
resolve: ((value) => void)
@@ -87,7 +87,7 @@
Returns void
+Defined in src/utility-types.ts:170
Readonly
workerNodeKey
workerNodeKey: number
@@ -95,7 +95,7 @@
+Defined in src/utility-types.ts:178
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:179
@@ -40,7 +40,7 @@
Optional
virtualTaskEndTimestamp
virtualTaskEndTimestamp?: number
+
Defined in src/pools/worker.ts:180
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:160
Readonly
dynamicWorkerUsage
dynamicWorkerUsage: boolean
@@ -52,7 +52,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:156
@@ -34,7 +34,7 @@
+
Defined in src/utility-types.ts:71
+
Defined in src/utility-types.ts:83
Optional
Readonly
name
name?: string
@@ -66,7 +66,7 @@
+Defined in src/utility-types.ts:79
Optional
Readonly
taskId
taskId?: string
@@ -74,7 +74,7 @@
+Defined in src/utility-types.ts:95
Optional
Readonly
timestamp
timestamp?: number
@@ -82,7 +82,7 @@
+Defined in src/utility-types.ts:91
Optional
Readonly
transferList
transferList?: TransferListItem[]
@@ -90,7 +90,7 @@
+Defined in src/utility-types.ts:87
Optional
Readonly
workerId
workerId?: number
@@ -98,7 +98,7 @@
+Defined in src/utility-types.ts:75
@@ -24,7 +24,7 @@
- TaskFunctionOperationResult
+
Defined in src/worker/task-functions.ts:50
+
Defined in src/worker/task-functions.ts:51
@@ -24,7 +24,7 @@
+
Defined in src/utility-types.ts:30
+
Defined in src/utility-types.ts:46
Readonly
name
name: string
@@ -54,7 +54,7 @@
+Defined in src/utility-types.ts:34
Optional
Readonly
runTime
runTime?: number
@@ -62,7 +62,7 @@
+Defined in src/utility-types.ts:42
Readonly
timestamp
timestamp: number
@@ -70,7 +70,7 @@
+Defined in src/utility-types.ts:38
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:82
+
Defined in src/pools/worker.ts:86
executing
executing: number
@@ -56,7 +56,7 @@
+Defined in src/pools/worker.ts:90
failed
failed: number
@@ -64,7 +64,7 @@
+Defined in src/pools/worker.ts:106
Optional
Readonly
maxQueued
maxQueued?: number
@@ -72,7 +72,7 @@
+Defined in src/pools/worker.ts:98
Readonly
queued
queued: number
@@ -80,7 +80,7 @@
+Defined in src/pools/worker.ts:94
stolen
stolen: number
@@ -88,7 +88,7 @@
+Defined in src/pools/worker.ts:102
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:136
Readonly
waitTime
@@ -61,7 +61,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:140
@@ -24,7 +24,7 @@
+
Defined in src/pools/pool.ts:104
+
Defined in src/pools/pool.ts:116
Optional
Readonly
size
size?: number
@@ -60,7 +60,7 @@
+Defined in src/pools/pool.ts:110
Optional
Readonly
taskStealing
taskStealing?: boolean
@@ -71,7 +71,7 @@
+Defined in src/pools/pool.ts:122
Optional
Readonly
tasksStealingOnBackPressure
tasksStealingOnBackPressure?: boolean
@@ -82,7 +82,7 @@
+Defined in src/pools/pool.ts:128
@@ -26,7 +26,7 @@
+
Defined in src/pools/thread/fixed.ts:18
+
Defined in src/pools/pool.ts:186
Optional
enableTasksQueue
enableTasksQueue?: boolean
@@ -72,7 +72,7 @@
+Defined in src/pools/pool.ts:192
Optional
errorHandler
@@ -83,7 +83,7 @@
+Defined in src/pools/pool.ts:154
Optional
exitHandler
@@ -94,7 +94,7 @@
+Defined in src/pools/pool.ts:160
Optional
messageHandler
@@ -105,7 +105,7 @@
+Defined in src/pools/pool.ts:148
Optional
onlineHandler
@@ -116,7 +116,7 @@
+Defined in src/pools/pool.ts:142
Optional
restartWorkerOnError
restartWorkerOnError?: boolean
@@ -125,7 +125,7 @@
+Defined in src/pools/pool.ts:180
Optional
startWorkers
startWorkers?: boolean
@@ -137,7 +137,7 @@
+Defined in src/pools/pool.ts:166
Optional
tasksQueueOptions
@@ -146,7 +146,7 @@
+Defined in src/pools/pool.ts:196
Optional
workerChoiceStrategy
workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -158,7 +158,7 @@
+Defined in src/pools/pool.ts:172
Optional
workerChoiceStrategyOptions
@@ -167,7 +167,7 @@
+Defined in src/pools/pool.ts:176
+Defined in src/pools/thread/fixed.ts:24
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:97
Optional
Readonly
measurement
measurement?: "runTime" | "waitTime" | "elu"
@@ -59,7 +59,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:79
Optional
Readonly
retries
retries?: number
@@ -70,7 +70,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:75
Optional
Readonly
runTime
@@ -81,7 +81,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:85
Optional
Readonly
waitTime
@@ -92,7 +92,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:91
Optional
Readonly
weights
weights?: Record<number, number>
@@ -104,7 +104,7 @@ A weight is tasks maximum execution time in milliseconds for a worker node.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:104
@@ -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/pools/worker.ts:127
+
Defined in src/pools/worker.ts:139
Readonly
id
id: undefined | number
@@ -55,7 +55,7 @@
+Defined in src/pools/worker.ts:131
ready
ready: boolean
@@ -63,7 +63,7 @@
+Defined in src/pools/worker.ts:143
Optional
taskFunctionNames
taskFunctionNames?: string[]
@@ -71,7 +71,7 @@
+Defined in src/pools/worker.ts:147
Readonly
type
type: "thread" | "cluster"
@@ -79,7 +79,7 @@
+Defined in src/pools/worker.ts:135
@@ -24,7 +24,7 @@
+
Defined in src/worker/worker-options.ts:28
@@ -51,7 +51,7 @@
Deprecated
This option will be removed in the next major version.
+
Defined in src/worker/worker-options.ts:65
Optional
killBehavior
killBehavior?: "SOFT" | "HARD"
@@ -67,7 +67,7 @@
+Defined in src/worker/worker-options.ts:39
Optional
killHandler
@@ -77,7 +77,7 @@
Default Value
() => {}
+Defined in src/worker/worker-options.ts:58
Optional
maxInactiveTime
maxInactiveTime?: number
@@ -95,7 +95,7 @@ when this timeout expires your tasks is interrupted before completion and remove
+Defined in src/worker/worker-options.ts:52
@@ -24,7 +24,7 @@
+
Defined in src/utility-types.ts:54
+
Defined in src/utility-types.ts:62
Readonly
runTime
runTime: boolean
@@ -52,7 +52,7 @@
+Defined in src/utility-types.ts:58
@@ -24,7 +24,7 @@
+
Defined in src/pools/worker.ts:155
+
Defined in src/pools/worker.ts:171
Readonly
runTime
@@ -54,7 +54,7 @@
+Defined in src/pools/worker.ts:163
Readonly
tasks
@@ -62,7 +62,7 @@
+Defined in src/pools/worker.ts:159
Readonly
waitTime
@@ -70,7 +70,7 @@
+Defined in src/pools/worker.ts:167
@@ -40,7 +40,7 @@
Returns void
+Defined in src/pools/worker.ts:21
@@ -40,7 +40,7 @@
Returns void
+Defined in src/pools/worker.ts:29
+Defined in src/worker/worker-options.ts:18
@@ -28,7 +28,7 @@
Returns void | Promise<void>
+Defined in src/worker/worker-options.ts:23
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:54
@@ -40,7 +40,7 @@
Returns void
+Defined in src/pools/worker.ts:13
@@ -38,7 +38,7 @@
Returns void
+Defined in src/pools/worker.ts:8
+Defined in src/pools/pool.ts:58
+Defined in src/pools/pool.ts:35
@@ -47,7 +47,7 @@ This function must return a promise.
Returns Promise<Response>
+Defined in src/worker/task-functions.ts:18
@@ -34,7 +34,7 @@ This function can be synchronous or asynchronous.
+
Defined in src/worker/task-functions.ts:29
@@ -36,7 +36,7 @@ The value is the function itself.
+
Defined in src/worker/task-functions.ts:42
@@ -46,7 +46,7 @@
Returns Response
+Defined in src/worker/task-functions.ts:7
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:40
@@ -36,7 +36,7 @@
Returns void
+Defined in src/pools/worker.ts:217
+Defined in src/pools/worker.ts:120
+Defined in src/worker/worker-options.ts:4
@@ -29,7 +29,7 @@
Readonly
waitTime: "waitTime"
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:45
@@ -37,7 +37,7 @@
Readonly
taskError: "taskError"
+Defined in src/pools/pool.ts:45
+Defined in src/pools/pool.ts:21
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
@@ -27,7 +27,7 @@
Readonly
thread: "thread"
+Defined in src/pools/worker.ts:112
Chooses a worker node in the pool and returns its key. -If the worker node is not eligible,
+If no worker nodes are not eligible,undefined
is returned.undefined
is returned. +Ifundefined
is returned, the caller retry.