From da631e977b488fb76cc1881c991a6fda8d8bb6e0 Mon Sep 17 00:00:00 2001
From: Documentation Bot
Date: Fri, 20 Oct 2023 20:31:33 +0000
Subject: [PATCH] docs: generate documentation
---
docs/classes/AbstractPool.html | 202 +++++++++---------
docs/classes/AbstractWorker.html | 78 +++----
docs/classes/CircularArray.html | 28 +--
docs/classes/ClusterWorker.html | 56 ++---
docs/classes/Deque.html | 38 ++--
docs/classes/DynamicClusterPool.html | 110 +++++-----
docs/classes/DynamicThreadPool.html | 110 +++++-----
docs/classes/FixedClusterPool.html | 110 +++++-----
docs/classes/FixedThreadPool.html | 110 +++++-----
docs/classes/Node.html | 16 +-
docs/classes/ThreadWorker.html | 58 ++---
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 | 22 +-
docs/interfaces/IWorkerNode.html | 42 ++--
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/WorkerNodeEventDetail.html | 10 +-
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/KillHandler.html | 8 +-
docs/types/Measurement.html | 8 +-
docs/types/MessageHandler.html | 8 +-
docs/types/OnlineHandler.html | 8 +-
docs/types/PoolEvent.html | 8 +-
docs/types/PoolType.html | 8 +-
docs/types/TaskAsyncFunction.html | 8 +-
docs/types/TaskFunction.html | 8 +-
docs/types/TaskFunctions.html | 8 +-
docs/types/TaskSyncFunction.html | 8 +-
docs/types/WorkerChoiceStrategy.html | 8 +-
docs/types/WorkerType.html | 8 +-
docs/types/Writable.html | 8 +-
docs/variables/KillBehaviors.html | 8 +-
docs/variables/Measurements.html | 8 +-
docs/variables/PoolEvents.html | 8 +-
docs/variables/PoolTypes.html | 8 +-
docs/variables/WorkerChoiceStrategies.html | 8 +-
docs/variables/WorkerTypes.html | 8 +-
65 files changed, 873 insertions(+), 873 deletions(-)
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 614932c40..4f501d6f5 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-AbstractPool | poolifier - v3.0.3
+AbstractPool | poolifier - v3.0.4
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:65
@@ -203,7 +203,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:127
Protected Readonly filePath
filePath: string
@@ -233,7 +233,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:129
Protected Optional Readonly max
max?: number
@@ -241,7 +241,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:79
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -249,7 +249,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:128
Protected Readonly opts
@@ -257,7 +257,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:130
Protected promiseResponseMap
@@ -270,7 +270,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:88
Private Readonly startTimestamp
startTimestamp: number
@@ -278,7 +278,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:118
Private started
started: boolean
@@ -286,7 +286,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:110
Private starting
starting: boolean
@@ -294,7 +294,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:114
Private Readonly taskFunctions
@@ -306,7 +306,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:105
Protected workerChoiceStrategyContext
@@ -314,7 +314,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:94
Readonly Internal workerNodes
@@ -323,7 +323,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:71
Accessors
@@ -337,7 +337,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
+Defined in src/pools/abstract-pool.ts:668
Protected full
@@ -349,7 +349,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
+Defined in src/pools/abstract-pool.ts:659
info
@@ -361,7 +361,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:272
Protected maxSize
@@ -372,7 +372,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns number
+Defined in src/pools/abstract-pool.ts:485
Protected minSize
@@ -383,7 +383,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns number
+Defined in src/pools/abstract-pool.ts:478
Private ready
@@ -394,7 +394,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
+Defined in src/pools/abstract-pool.ts:430
Protected Abstract type
@@ -406,7 +406,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:468
Private utilization
@@ -418,7 +418,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:447
Protected Abstract worker
@@ -429,7 +429,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:473
Methods
@@ -462,7 +462,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/abstract-pool.ts:804
+Defined in src/pools/abstract-pool.ts:1613
Protected afterTaskExecutionHook
@@ -509,7 +509,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1041
Protected afterWorkerNodeSetup
@@ -529,7 +529,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1354
Protected beforeTaskExecutionHook
@@ -554,7 +554,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1011
Private buildTasksQueueOptions
@@ -567,7 +567,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:598
Private checkAndEmitDynamicWorkerCreationEvents
@@ -575,7 +575,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1588
Private checkAndEmitTaskExecutionEvents
@@ -583,7 +583,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1576
Private checkAndEmitTaskQueuingEvents
@@ -591,7 +591,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1582
Private checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:495
Private checkNumberOfWorkers
@@ -625,7 +625,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:171
Private checkPoolOptions
@@ -638,7 +638,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:189
Private checkValidWorkerChoiceStrategyOptions
@@ -651,7 +651,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:218
Private chooseWorkerNode
@@ -664,7 +664,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1168
Protected createAndSetupDynamicWorkerNode
@@ -676,7 +676,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1258
Protected createAndSetupWorkerNode
@@ -688,7 +688,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1214
Protected Abstract createWorker
@@ -700,7 +700,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1207
Private deleteTaskFunctionWorkerUsages
@@ -713,7 +713,7 @@ Can be overridden.
name: string
Returns void
+Defined in src/pools/abstract-pool.ts:863
Private dequeueTask
@@ -726,7 +726,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1682
Protected Abstract deregisterWorkerMessageListener
@@ -766,7 +766,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1341
+Defined in src/pools/abstract-pool.ts:948
Protected Abstract destroyWorkerNode
@@ -797,7 +797,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:987
+Defined in src/pools/abstract-pool.ts:563
Private enqueueTask
@@ -837,7 +837,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1676
+Defined in src/pools/abstract-pool.ts:878
Private executeTask
@@ -892,7 +892,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1670
Protected flagWorkerNodeAsNotReady
@@ -905,7 +905,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1643
Protected flushTasksQueue
@@ -918,7 +918,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1690
Private flushTasksQueues
@@ -926,7 +926,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1700
Protected getWorkerInfo
@@ -946,7 +946,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1602
Private getWorkerNodeKeyByWorker
@@ -966,7 +966,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:511
Private getWorkerNodeKeyByWorkerId
@@ -986,7 +986,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:523
Private Readonly handleBackPressureEvent
@@ -999,7 +999,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1476
Private Readonly handleEmptyQueueEvent
@@ -1012,7 +1012,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1444
Private handleTaskExecutionResponse
@@ -1025,7 +1025,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1548
Private handleWorkerReadyResponse
@@ -1038,7 +1038,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1532
Private hasBackPressure
@@ -1046,7 +1046,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1655
+Defined in src/pools/abstract-pool.ts:791
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1648
Private initializeEventEmitter
@@ -1096,7 +1096,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:265
Protected internalBusy
@@ -1108,7 +1108,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:675
Protected Abstract isMain
@@ -1119,7 +1119,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1002
+Defined in src/pools/abstract-pool.ts:843
Private redistributeQueuedTasks
@@ -1145,7 +1145,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1404
Protected Abstract registerOnceWorkerMessageListener
@@ -1185,7 +1185,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1328
Protected Abstract registerWorkerMessageListener
@@ -1225,7 +1225,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1315
+Defined in src/pools/abstract-pool.ts:827
Private removeWorkerNode
@@ -1265,7 +1265,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1635
Protected sendKillMessageToWorker
@@ -1278,7 +1278,7 @@ Can be overridden.
workerNodeKey: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:959
Protected Abstract sendStartupMessageToWorker
@@ -1297,7 +1297,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1385
Private sendStatisticsMessageToWorker
@@ -1316,7 +1316,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1392
Private sendTaskFunctionOperationToWorker
@@ -1331,7 +1331,7 @@ Can be overridden.
Returns Promise<boolean>
+Defined in src/pools/abstract-pool.ts:694
Private sendTaskFunctionOperationToWorkers
@@ -1344,7 +1344,7 @@ Can be overridden.
Returns Promise<boolean>
+Defined in src/pools/abstract-pool.ts:735
Protected Abstract sendToWorker
@@ -1373,7 +1373,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1196
+Defined in src/pools/abstract-pool.ts:856
Private setTaskStealing
@@ -1402,7 +1402,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:618
+Defined in src/pools/abstract-pool.ts:577
Private setTasksQueueSize
@@ -1435,7 +1435,7 @@ Can be overridden.
size: number
Returns void
+Defined in src/pools/abstract-pool.ts:612
Private setTasksStealingOnBackPressure
@@ -1443,7 +1443,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:636
+Defined in src/pools/abstract-pool.ts:530
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:549
Protected setupHook
@@ -1500,7 +1500,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:995
Private shallCreateDynamicWorker
@@ -1512,7 +1512,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1185
Private shallExecuteTask
@@ -1525,7 +1525,7 @@ Can be overridden.
workerNodeKey: number
Returns boolean
+Defined in src/pools/abstract-pool.ts:869
Private shallUpdateTaskFunctionWorkerUsage
@@ -1545,7 +1545,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1074
+Defined in src/pools/abstract-pool.ts:932
Private tasksQueueSize
@@ -1570,7 +1570,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1686
Private unsetTaskStealing
@@ -1578,7 +1578,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:627
Private unsetTasksStealingOnBackPressure
@@ -1586,7 +1586,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:645
Private updateEluWorkerUsage
@@ -1601,7 +1601,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1128
Private updateRunTimeWorkerUsage
@@ -1616,7 +1616,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1101
Private updateTaskStatisticsWorkerUsage
@@ -1631,7 +1631,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1083
Private updateTaskStolenStatisticsWorkerUsage
@@ -1646,7 +1646,7 @@ Can be overridden.
taskName: string
Returns void
+Defined in src/pools/abstract-pool.ts:1425
Private updateWaitTimeWorkerUsage
@@ -1661,7 +1661,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:1115
Protected workerMessageListener
@@ -1677,7 +1677,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1516
+
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
asyncId
@@ -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
bind
@@ -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
emitDestroy
@@ -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
@@ -449,7 +449,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:371
Protected Abstract handleReadyMessage
@@ -468,7 +468,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:299
Protected handleTaskFunctionOperationMessage
@@ -481,7 +481,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:326
hasTaskFunction
@@ -501,7 +501,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:162
listTaskFunctionNames
@@ -513,7 +513,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:243
Protected messageListener
@@ -532,7 +532,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:306
removeTaskFunction
@@ -552,7 +552,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:214
Protected run
@@ -571,7 +571,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:494
Protected runAsync
@@ -595,7 +595,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:555
runInAsyncScope
@@ -674,7 +674,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:521
Protected sendTaskFunctionNamesToMainWorker
@@ -685,7 +685,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:473
Protected Abstract sendToMainWorker
@@ -704,7 +704,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:466
setDefaultTaskFunction
@@ -724,7 +724,7 @@ then restore the original execution context.
+Defined in src/worker/abstract-worker.ts:270
Private startCheckActive
@@ -735,7 +735,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:418
Private stopCheckActive
@@ -746,7 +746,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:429
triggerAsyncId
@@ -765,7 +765,7 @@ then restore the original execution context.
-
Returns void
+Defined in src/worker/abstract-worker.ts:617
Static bind
@@ -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
asyncId
@@ -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 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
@@ -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
@@ -157,7 +157,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+
Defined in src/pools/cluster/dynamic.ts:28
Protected Readonly filePath
filePath: string
@@ -188,7 +188,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:129
Protected Readonly max
max: number
@@ -197,7 +197,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/cluster/dynamic.ts:30
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -206,7 +206,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:128
Protected Readonly opts
@@ -215,7 +215,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/cluster/fixed.ts:47
Protected promiseResponseMap
@@ -229,7 +229,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:88
Protected workerChoiceStrategyContext
@@ -238,7 +238,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:94
Readonly Internal workerNodes
@@ -247,7 +247,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:71
Protected full
@@ -275,7 +275,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:659
info
@@ -287,7 +287,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:272
Protected maxSize
@@ -299,7 +299,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:485
Protected minSize
@@ -311,7 +311,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:478
Private ready
@@ -323,7 +323,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:430
Protected type
@@ -336,7 +336,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/cluster/dynamic.ts:39
Private utilization
@@ -349,7 +349,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:447
Protected worker
@@ -361,7 +361,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/cluster/fixed.ts:135
Protected afterTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:1041
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1354
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:1011
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1258
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1214
+
Defined in src/pools/cluster/fixed.ts:125
Protected deregisterWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:117
+
Defined in src/pools/abstract-pool.ts:948
Protected destroyWorkerNode
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:563
+
Defined in src/pools/abstract-pool.ts:878
Protected flagWorkerNodeAsNotReady
+
Defined in src/pools/abstract-pool.ts:1643
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1690
+
Defined in src/pools/abstract-pool.ts:1602
+
Defined in src/pools/abstract-pool.ts:791
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1648
+
Defined in src/pools/abstract-pool.ts:675
+
Defined in src/pools/cluster/fixed.ts:58
+
Defined in src/pools/abstract-pool.ts:843
Protected registerOnceWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:109
Protected registerWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:101
+
Defined in src/pools/abstract-pool.ts:827
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:959
Protected sendStartupMessageToWorker
+
Defined in src/pools/cluster/fixed.ts:94
+
Defined in src/pools/cluster/fixed.ts:83
+
Defined in src/pools/abstract-pool.ts:856
+
Defined in src/pools/abstract-pool.ts:577
+
Defined in src/pools/abstract-pool.ts:530
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:549
+
Defined in src/pools/cluster/fixed.ts:53
+
Defined in src/pools/abstract-pool.ts:932
Protected workerMessageListener
+
Defined in src/pools/abstract-pool.ts:1516
@@ -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
@@ -157,7 +157,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+
Defined in src/pools/thread/dynamic.ts:28
Protected Readonly filePath
filePath: string
@@ -188,7 +188,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:129
Protected Readonly max
max: number
@@ -197,7 +197,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/thread/dynamic.ts:30
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -206,7 +206,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:128
Protected Readonly opts
@@ -215,7 +215,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/thread/fixed.ts:49
Protected promiseResponseMap
@@ -229,7 +229,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:88
Protected workerChoiceStrategyContext
@@ -238,7 +238,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:94
Readonly Internal workerNodes
@@ -247,7 +247,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:71
Protected full
@@ -275,7 +275,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:659
info
@@ -287,7 +287,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:272
Protected maxSize
@@ -299,7 +299,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:485
Protected minSize
@@ -311,7 +311,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:478
Private ready
@@ -323,7 +323,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:430
Protected type
@@ -336,7 +336,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/thread/dynamic.ts:39
Private utilization
@@ -349,7 +349,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:447
Protected worker
@@ -361,7 +361,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/thread/fixed.ts:150
Protected afterTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:1041
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1354
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:1011
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1258
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1214
+
Defined in src/pools/thread/fixed.ts:137
Protected deregisterWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:127
+
Defined in src/pools/abstract-pool.ts:948
Protected destroyWorkerNode
+
Defined in src/pools/thread/fixed.ts:60
+
Defined in src/pools/abstract-pool.ts:563
+
Defined in src/pools/abstract-pool.ts:878
Protected flagWorkerNodeAsNotReady
+
Defined in src/pools/abstract-pool.ts:1643
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1690
+
Defined in src/pools/abstract-pool.ts:1602
+
Defined in src/pools/abstract-pool.ts:791
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1648
+
Defined in src/pools/abstract-pool.ts:675
+
Defined in src/pools/thread/fixed.ts:55
+
Defined in src/pools/abstract-pool.ts:843
Protected registerOnceWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:117
Protected registerWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:107
+
Defined in src/pools/abstract-pool.ts:827
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:959
Protected sendStartupMessageToWorker
+
Defined in src/pools/thread/fixed.ts:92
+
Defined in src/pools/thread/fixed.ts:78
+
Defined in src/pools/abstract-pool.ts:856
+
Defined in src/pools/abstract-pool.ts:577
+
Defined in src/pools/abstract-pool.ts:530
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:549
+
Defined in src/pools/abstract-pool.ts:995
+
Defined in src/pools/abstract-pool.ts:932
Protected workerMessageListener
+
Defined in src/pools/abstract-pool.ts:1516
@@ -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
@@ -183,7 +183,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:129
Protected Optional Readonly max
max?: number
@@ -192,7 +192,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:79
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -201,7 +201,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:128
Protected Readonly opts
@@ -210,7 +210,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/cluster/fixed.ts:47
Protected promiseResponseMap
@@ -224,7 +224,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:88
Protected workerChoiceStrategyContext
@@ -233,7 +233,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:94
Readonly Internal workerNodes
@@ -242,7 +242,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:71
Protected full
@@ -270,7 +270,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:659
info
@@ -282,7 +282,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:272
Protected maxSize
@@ -294,7 +294,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:485
Protected minSize
@@ -306,7 +306,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:478
Private ready
@@ -318,7 +318,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:430
Protected type
@@ -331,7 +331,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/cluster/fixed.ts:130
Private utilization
@@ -344,7 +344,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:447
Protected worker
@@ -356,7 +356,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/cluster/fixed.ts:135
Protected afterTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:1041
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1354
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:1011
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1258
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1214
+
Defined in src/pools/cluster/fixed.ts:125
Protected deregisterWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:117
+
Defined in src/pools/abstract-pool.ts:948
Protected destroyWorkerNode
+
Defined in src/pools/cluster/fixed.ts:63
+
Defined in src/pools/abstract-pool.ts:563
+
Defined in src/pools/abstract-pool.ts:878
Protected flagWorkerNodeAsNotReady
+
Defined in src/pools/abstract-pool.ts:1643
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1690
+
Defined in src/pools/abstract-pool.ts:1602
+
Defined in src/pools/abstract-pool.ts:791
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1648
+
Defined in src/pools/abstract-pool.ts:675
+
Defined in src/pools/cluster/fixed.ts:58
+
Defined in src/pools/abstract-pool.ts:843
Protected registerOnceWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:109
Protected registerWorkerMessageListener
+
Defined in src/pools/cluster/fixed.ts:101
+
Defined in src/pools/abstract-pool.ts:827
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:959
Protected sendStartupMessageToWorker
+
Defined in src/pools/cluster/fixed.ts:94
+
Defined in src/pools/cluster/fixed.ts:83
+
Defined in src/pools/abstract-pool.ts:856
+
Defined in src/pools/abstract-pool.ts:577
+
Defined in src/pools/abstract-pool.ts:530
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:549
+
Defined in src/pools/cluster/fixed.ts:53
+
Defined in src/pools/abstract-pool.ts:932
Protected workerMessageListener
+
Defined in src/pools/abstract-pool.ts:1516
@@ -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
@@ -183,7 +183,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:129
Protected Optional Readonly max
max?: number
@@ -192,7 +192,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:79
Protected Readonly numberOfWorkers
numberOfWorkers: number
@@ -201,7 +201,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:128
Protected Readonly opts
@@ -210,7 +210,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/thread/fixed.ts:49
Protected promiseResponseMap
@@ -224,7 +224,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:88
Protected workerChoiceStrategyContext
@@ -233,7 +233,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:94
Readonly Internal workerNodes
@@ -242,7 +242,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:71
Protected full
@@ -270,7 +270,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:659
info
@@ -282,7 +282,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:272
Protected maxSize
@@ -294,7 +294,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:485
Protected minSize
@@ -306,7 +306,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:478
Private ready
@@ -318,7 +318,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:430
Protected type
@@ -331,7 +331,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/thread/fixed.ts:145
Private utilization
@@ -344,7 +344,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/abstract-pool.ts:447
Protected worker
@@ -356,7 +356,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+
Defined in src/pools/thread/fixed.ts:150
Protected afterTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:1041
Protected afterWorkerNodeSetup
+
Defined in src/pools/abstract-pool.ts:1354
Protected beforeTaskExecutionHook
+
Defined in src/pools/abstract-pool.ts:1011
Protected createAndSetupDynamicWorkerNode
+
Defined in src/pools/abstract-pool.ts:1258
Protected createAndSetupWorkerNode
+
Defined in src/pools/abstract-pool.ts:1214
+
Defined in src/pools/thread/fixed.ts:137
Protected deregisterWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:127
+
Defined in src/pools/abstract-pool.ts:948
Protected destroyWorkerNode
+
Defined in src/pools/thread/fixed.ts:60
+
Defined in src/pools/abstract-pool.ts:563
+
Defined in src/pools/abstract-pool.ts:878
Protected flagWorkerNodeAsNotReady
+
Defined in src/pools/abstract-pool.ts:1643
Protected flushTasksQueue
+
Defined in src/pools/abstract-pool.ts:1690
+
Defined in src/pools/abstract-pool.ts:1602
+
Defined in src/pools/abstract-pool.ts:791
hasWorkerNodeBackPressure
+
Defined in src/pools/abstract-pool.ts:1648
+
Defined in src/pools/abstract-pool.ts:675
+
Defined in src/pools/thread/fixed.ts:55
+
Defined in src/pools/abstract-pool.ts:843
Protected registerOnceWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:117
Protected registerWorkerMessageListener
+
Defined in src/pools/thread/fixed.ts:107
+
Defined in src/pools/abstract-pool.ts:827
Protected sendKillMessageToWorker
+
Defined in src/pools/abstract-pool.ts:959
Protected sendStartupMessageToWorker
+
Defined in src/pools/thread/fixed.ts:92
+
Defined in src/pools/thread/fixed.ts:78
+
Defined in src/pools/abstract-pool.ts:856
+
Defined in src/pools/abstract-pool.ts:577
+
Defined in src/pools/abstract-pool.ts:530
setWorkerChoiceStrategyOptions
+
Defined in src/pools/abstract-pool.ts:549
+
Defined in src/pools/abstract-pool.ts:995
+
Defined in src/pools/abstract-pool.ts:932
Protected workerMessageListener
+
Defined in src/pools/abstract-pool.ts:1516
@@ -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
@@ -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
asyncId
@@ -305,7 +305,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:454
+Defined in src/worker/thread-worker.ts:97
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 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 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 - v3.0.3
+
poolifier - v3.0.4
Index
@@ -110,7 +110,7 @@
Theme
@@ -26,7 +26,7 @@
+
Defined in src/pools/cluster/fixed.ts:10
+
Defined in src/pools/pool.ts:181
Optional enableTasksQueue
enableTasksQueue?: boolean
@@ -73,7 +73,7 @@
+Defined in src/pools/pool.ts:187
+Defined in src/pools/cluster/fixed.ts:16
Optional errorHandler
@@ -94,7 +94,7 @@
+Defined in src/pools/pool.ts:149
Optional exitHandler
@@ -105,7 +105,7 @@
+Defined in src/pools/pool.ts:155
Optional messageHandler
@@ -116,7 +116,7 @@
+Defined in src/pools/pool.ts:143
Optional onlineHandler
@@ -127,7 +127,7 @@
+Defined in src/pools/pool.ts:137
Optional restartWorkerOnError
restartWorkerOnError?: boolean
@@ -136,7 +136,7 @@
+Defined in src/pools/pool.ts:175
+Defined in src/pools/cluster/fixed.ts:22
Optional startWorkers
startWorkers?: boolean
@@ -158,7 +158,7 @@
+Defined in src/pools/pool.ts:161
Optional tasksQueueOptions
@@ -167,7 +167,7 @@
+Defined in src/pools/pool.ts:191
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:167
Optional workerChoiceStrategyOptions
@@ -188,7 +188,7 @@
+Defined in src/pools/pool.ts:171
@@ -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:201
+Defined in src/pools/pool.ts:277
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:259
Optional Readonly emitter
emitter?: EventEmitterAsyncResource
@@ -142,7 +142,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:238
Readonly enableTasksQueue
enableTasksQueue: ((enable, tasksQueueOptions?) => void)
@@ -171,7 +171,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns void
+Defined in src/pools/pool.ts:325
Readonly execute
execute: ((data?, name?, transferList?) => Promise<Response>)
@@ -206,7 +206,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:247
Readonly hasTaskFunction
hasTaskFunction: ((name) => boolean)
@@ -231,7 +231,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:266
Readonly hasWorkerNodeBackPressure
hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
@@ -256,7 +256,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:223
Readonly info
@@ -264,7 +264,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:209
Readonly listTaskFunctionNames
listTaskFunctionNames: (() => string[])
@@ -281,7 +281,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:293
Readonly removeTaskFunction
removeTaskFunction: ((name) => Promise<boolean>)
@@ -306,7 +306,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:287
Readonly setDefaultTaskFunction
setDefaultTaskFunction: ((name) => Promise<boolean>)
@@ -331,7 +331,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:300
Readonly setTasksQueueOptions
setTasksQueueOptions: ((tasksQueueOptions) => void)
@@ -355,7 +355,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns void
+Defined in src/pools/pool.ts:334
Readonly setWorkerChoiceStrategy
setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
@@ -384,7 +384,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns void
+Defined in src/pools/pool.ts:307
Readonly setWorkerChoiceStrategyOptions
setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
@@ -408,7 +408,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns void
+Defined in src/pools/pool.ts:316
Readonly start
start: (() => void)
@@ -424,7 +424,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns void
+Defined in src/pools/pool.ts:255
Readonly Internal workerNodes
@@ -432,7 +432,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:215
@@ -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
@@ -60,7 +60,7 @@ If undefined is returned, the caller retry.
+
Defined in src/pools/selection-strategies/selection-strategies-types.ts:197
Readonly remove
remove: ((workerNodeKey) => boolean)
@@ -85,7 +85,7 @@ If undefined is returned, the caller retry.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:204
Readonly reset
reset: (() => boolean)
@@ -102,7 +102,7 @@ If undefined is returned, the caller retry.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:182
Readonly setOptions
setOptions: ((opts) => void)
@@ -126,7 +126,7 @@ If undefined is returned, the caller retry.
Returns void
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:210
Readonly strategyPolicy
@@ -134,7 +134,7 @@ If undefined is returned, the caller retry.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:172
Readonly taskStatisticsRequirements
@@ -142,7 +142,7 @@ If undefined is returned, the caller retry.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:176
Readonly update
update: ((workerNodeKey) => boolean)
@@ -165,7 +165,7 @@ This is called after a task has been executed on a worker node.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:189
@@ -39,7 +39,7 @@
+
Defined in src/pools/worker.ts:227
@@ -88,7 +88,7 @@
Returns void
+
Defined in src/pools/worker.ts:290
Readonly closeChannel
closeChannel: (() => void)
@@ -104,7 +104,7 @@
Returns void
+Defined in src/pools/worker.ts:304
Readonly deleteTaskFunctionWorkerUsage
deleteTaskFunctionWorkerUsage: ((name) => boolean)
@@ -129,7 +129,7 @@
+Defined in src/pools/worker.ts:318
Readonly dequeueTask
dequeueTask: (() => undefined | Task<Data>)
@@ -146,7 +146,7 @@
+Defined in src/pools/worker.ts:280
Readonly enqueueTask
enqueueTask: ((task) => number)
@@ -171,7 +171,7 @@
+Defined in src/pools/worker.ts:267
Readonly getTaskFunctionWorkerUsage
getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
@@ -196,7 +196,7 @@
+Defined in src/pools/worker.ts:311
Readonly hasBackPressure
hasBackPressure: (() => boolean)
@@ -213,7 +213,7 @@
+Defined in src/pools/worker.ts:296
Readonly info
@@ -221,7 +221,7 @@
+Defined in src/pools/worker.ts:236
Optional Readonly messageChannel
messageChannel?: MessageChannel
@@ -229,7 +229,7 @@
+Defined in src/pools/worker.ts:249
Readonly popTask
popTask: (() => undefined | Task<Data>)
@@ -246,7 +246,7 @@
+Defined in src/pools/worker.ts:286
Readonly resetUsage
resetUsage: (() => void)
@@ -262,7 +262,7 @@
Returns void
+Defined in src/pools/worker.ts:300
Optional strategyData
@@ -271,7 +271,7 @@ This is used to store data that are specific to the worker choice strategy.
+Defined in src/pools/worker.ts:245
tasksQueueBackPressureSize
tasksQueueBackPressureSize: number
@@ -280,7 +280,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:254
Readonly tasksQueueSize
tasksQueueSize: (() => number)
@@ -297,7 +297,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:260
Readonly unshiftTask
unshiftTask: ((task) => number)
@@ -322,7 +322,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:274
Readonly usage
@@ -330,7 +330,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:240
Readonly worker
worker: Worker
@@ -338,7 +338,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:232
@@ -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:58
@@ -60,7 +60,7 @@
Optional Readonly backPressure
backPressure?: boolean
+Defined in src/pools/pool.ts:79
Readonly busyWorkerNodes
busyWorkerNodes: number
@@ -68,22 +68,22 @@
+
Defined in src/pools/pool.ts:74
Readonly executedTasks
executedTasks: number
+
Defined in src/pools/pool.ts:75
Readonly executingTasks
executingTasks: number
+
Defined in src/pools/pool.ts:76
Readonly failedTasks
failedTasks: number
+
Defined in src/pools/pool.ts:81
Readonly idleWorkerNodes
idleWorkerNodes: number
@@ -91,32 +91,32 @@
+Defined in src/pools/pool.ts:72
Optional Readonly maxQueuedTasks
maxQueuedTasks?: number
+Defined in src/pools/pool.ts:78
Readonly maxSize
maxSize: number
+Defined in src/pools/pool.ts:66
Readonly minSize
minSize: number
+Defined in src/pools/pool.ts:65
Optional Readonly queuedTasks
queuedTasks?: number
+Defined in src/pools/pool.ts:77
Readonly ready
ready: boolean
+Defined in src/pools/pool.ts:63
Optional Readonly runTime
runTime?: {
    average?: number;
    maximum: number;
    median?: number;
    minimum: number;
}
@@ -132,27 +132,27 @@
Readonly minimum: number
+Defined in src/pools/pool.ts:82
Readonly started
started: boolean
+Defined in src/pools/pool.ts:62
Optional Readonly stolenTasks
stolenTasks?: number
+Defined in src/pools/pool.ts:80
Readonly strategy
strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+Defined in src/pools/pool.ts:64
Readonly type
type: "fixed" | "dynamic"
+Defined in src/pools/pool.ts:60
Optional Readonly utilization
utilization?: number
@@ -160,12 +160,12 @@
+Defined in src/pools/pool.ts:68
Readonly version
version: string
+Defined in src/pools/pool.ts:59
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:88
Readonly worker
worker: "thread" | "cluster"
+Defined in src/pools/pool.ts:61
Readonly workerNodes
workerNodes: number
@@ -194,7 +194,7 @@
+Defined in src/pools/pool.ts:70
+
Defined in src/pools/pool.ts:181
Optional enableTasksQueue
enableTasksQueue?: boolean
@@ -78,7 +78,7 @@
+Defined in src/pools/pool.ts:187
Optional errorHandler
@@ -88,7 +88,7 @@
Default Value
() => {}
+Defined in src/pools/pool.ts:149
Optional exitHandler
@@ -98,7 +98,7 @@
Default Value
() => {}
+Defined in src/pools/pool.ts:155
Optional messageHandler
@@ -108,7 +108,7 @@
Default Value
() => {}
+Defined in src/pools/pool.ts:143
Optional onlineHandler
@@ -118,7 +118,7 @@
Default Value
() => {}
+Defined in src/pools/pool.ts:137
Optional restartWorkerOnError
restartWorkerOnError?: boolean
@@ -126,7 +126,7 @@
+Defined in src/pools/pool.ts:175
Optional startWorkers
startWorkers?: boolean
@@ -137,7 +137,7 @@
+Defined in src/pools/pool.ts:161
Optional tasksQueueOptions
@@ -145,7 +145,7 @@
+Defined in src/pools/pool.ts:191
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:167
Optional workerChoiceStrategyOptions
@@ -164,7 +164,7 @@
+Defined in src/pools/pool.ts:171
@@ -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:99
+
Defined in src/pools/pool.ts:111
Optional Readonly size
size?: number
@@ -60,7 +60,7 @@
+Defined in src/pools/pool.ts:105
Optional Readonly taskStealing
taskStealing?: boolean
@@ -71,7 +71,7 @@
+Defined in src/pools/pool.ts:117
Optional Readonly tasksStealingOnBackPressure
tasksStealingOnBackPressure?: boolean
@@ -82,7 +82,7 @@
+Defined in src/pools/pool.ts:123
@@ -26,7 +26,7 @@
+
Defined in src/pools/thread/fixed.ts:18
+
Defined in src/pools/pool.ts:181
Optional enableTasksQueue
enableTasksQueue?: boolean
@@ -72,7 +72,7 @@
+Defined in src/pools/pool.ts:187
Optional errorHandler
@@ -83,7 +83,7 @@
+Defined in src/pools/pool.ts:149
Optional exitHandler
@@ -94,7 +94,7 @@
+Defined in src/pools/pool.ts:155
Optional messageHandler
@@ -105,7 +105,7 @@
+Defined in src/pools/pool.ts:143
Optional onlineHandler
@@ -116,7 +116,7 @@
+Defined in src/pools/pool.ts:137
Optional restartWorkerOnError
restartWorkerOnError?: boolean
@@ -125,7 +125,7 @@
+Defined in src/pools/pool.ts:175
Optional startWorkers
startWorkers?: boolean
@@ -137,7 +137,7 @@
+Defined in src/pools/pool.ts:161
Optional tasksQueueOptions
@@ -146,7 +146,7 @@
+Defined in src/pools/pool.ts:191
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:167
Optional workerChoiceStrategyOptions
@@ -167,7 +167,7 @@
+Defined in src/pools/pool.ts:171
+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/pools/worker.ts:216
@@ -40,7 +40,7 @@
workerId
workerId: number
+
Defined in src/pools/worker.ts:217
+
Defined in src/worker/worker-options.ts:39
Optional killHandler
@@ -63,7 +63,7 @@
Default Value
() => {}
+Defined in src/worker/worker-options.ts:58
Optional maxInactiveTime
maxInactiveTime?: number
@@ -81,7 +81,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:53
+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
+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:40
+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