From a109e1c64ce3cff450fa79aebfa4de0ac3662be9 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Sun, 9 Jul 2023 12:17:46 +0000
Subject: [PATCH] chore: generate documentation
---
docs/classes/AbstractPool.html | 140 +++++++++---------
docs/classes/AbstractWorker.html | 52 +++----
docs/classes/CircularArray.html | 22 +--
docs/classes/ClusterWorker.html | 34 ++---
docs/classes/DynamicClusterPool.html | 78 +++++-----
docs/classes/DynamicThreadPool.html | 78 +++++-----
docs/classes/FixedClusterPool.html | 76 +++++-----
docs/classes/FixedThreadPool.html | 76 +++++-----
docs/classes/PoolEmitter.html | 2 +-
docs/classes/Queue.html | 20 +--
docs/classes/ThreadWorker.html | 34 ++---
docs/classes/WorkerChoiceStrategyContext.html | 22 +--
docs/functions/availableParallelism.html | 2 +-
docs/interfaces/ClusterPoolOptions.html | 26 ++--
...tLoopUtilizationMeasurementStatistics.html | 8 +-
docs/interfaces/IPool.html | 20 +--
docs/interfaces/IWorker.html | 10 +-
docs/interfaces/IWorkerChoiceStrategy.html | 18 +--
docs/interfaces/IWorkerNode.html | 18 +--
docs/interfaces/MeasurementOptions.html | 4 +-
docs/interfaces/MeasurementStatistics.html | 14 +-
.../MeasurementStatisticsRequirements.html | 8 +-
docs/interfaces/MessageValue.html | 24 +--
docs/interfaces/PoolInfo.html | 38 ++---
docs/interfaces/PoolOptions.html | 22 +--
docs/interfaces/PromiseResponseWrapper.html | 8 +-
docs/interfaces/StrategyPolicy.html | 4 +-
docs/interfaces/Task.html | 12 +-
docs/interfaces/TaskError.html | 6 +-
docs/interfaces/TaskPerformance.html | 8 +-
docs/interfaces/TaskStatistics.html | 12 +-
.../TaskStatisticsRequirements.html | 8 +-
docs/interfaces/TasksQueueOptions.html | 4 +-
docs/interfaces/ThreadPoolOptions.html | 24 +--
.../WorkerChoiceStrategyOptions.html | 12 +-
docs/interfaces/WorkerInfo.html | 10 +-
docs/interfaces/WorkerOptions.html | 8 +-
docs/interfaces/WorkerStatistics.html | 6 +-
docs/interfaces/WorkerUsage.html | 10 +-
docs/types/ErrorHandler.html | 2 +-
docs/types/ExitHandler.html | 2 +-
docs/types/KillBehavior.html | 2 +-
docs/types/Measurement.html | 2 +-
docs/types/MessageHandler.html | 2 +-
docs/types/OnlineHandler.html | 2 +-
docs/types/PoolEvent.html | 2 +-
docs/types/PoolType.html | 2 +-
docs/types/TaskFunctions.html | 2 +-
docs/types/WorkerAsyncFunction.html | 2 +-
docs/types/WorkerChoiceStrategy.html | 2 +-
docs/types/WorkerFunction.html | 2 +-
docs/types/WorkerSyncFunction.html | 2 +-
docs/types/WorkerType.html | 2 +-
docs/variables/KillBehaviors.html | 2 +-
docs/variables/Measurements.html | 2 +-
docs/variables/PoolEvents.html | 2 +-
docs/variables/PoolTypes.html | 2 +-
docs/variables/WorkerChoiceStrategies.html | 2 +-
docs/variables/WorkerTypes.html | 2 +-
59 files changed, 509 insertions(+), 509 deletions(-)
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index bbe344d9..e0c7cbe3 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:49
@@ -175,7 +175,7 @@
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:94
Protected
Readonly
file Path
file Path : string
@@ -202,7 +202,7 @@
+Defined in src/pools/abstract-pool.ts:96
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -210,7 +210,7 @@
+Defined in src/pools/abstract-pool.ts:95
Protected
Readonly
opts
@@ -218,7 +218,7 @@
+Defined in src/pools/abstract-pool.ts:97
Protected
promise Response Map
@@ -231,7 +231,7 @@
+Defined in src/pools/abstract-pool.ts:68
Private
Readonly
start Timestamp
start Timestamp : number
@@ -239,7 +239,7 @@
+Defined in src/pools/abstract-pool.ts:85
Protected
worker Choice Strategy Context
@@ -247,7 +247,7 @@
+Defined in src/pools/abstract-pool.ts:76
Readonly
worker Nodes
@@ -256,7 +256,7 @@
+Defined in src/pools/abstract-pool.ts:55
Protected
full
@@ -282,7 +282,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:562
+Defined in src/pools/abstract-pool.ts:268
Protected
Abstract
max Size
@@ -305,7 +305,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:460
Protected
Abstract
min Size
@@ -316,7 +316,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:455
Private
ready
@@ -324,7 +324,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:412
Private
starting
@@ -332,7 +332,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:404
Protected
Abstract
type
@@ -344,7 +344,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:445
+Defined in src/pools/abstract-pool.ts:424
Protected
Abstract
worker
@@ -367,7 +367,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:450
Protected
after Worker Setup
@@ -414,7 +414,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:911
Protected
before Task Execution Hook
@@ -439,7 +439,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:667
Private
build Tasks Queue Options
@@ -452,7 +452,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:549
Private
check And Emit Events
@@ -460,7 +460,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1074
Protected
check Dynamic Pool Size
@@ -475,7 +475,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:160
Private
check File Path
@@ -488,7 +488,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:133
Private
check Message Worker Id
@@ -501,7 +501,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:473
Private
check Number Of Workers
@@ -514,7 +514,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:142
Private
check Pool Options
@@ -527,7 +527,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:178
Private
check Valid Tasks Queue Options
@@ -540,7 +540,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:243
Private
check Valid Worker Choice Strategy
@@ -553,7 +553,7 @@ Can be overridden.
workerChoiceStrategy : "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Returns void
+Defined in src/pools/abstract-pool.ts:205
Private
check Valid Worker Choice Strategy Options
@@ -566,7 +566,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:215
Private
choose Worker Node
@@ -579,7 +579,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:853
Protected
create And Setup Dynamic Worker
@@ -591,7 +591,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:994
Protected
create And Setup Worker
@@ -603,7 +603,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:928
Protected
Abstract
create Worker
@@ -615,7 +615,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:903
Private
dequeue Task
@@ -628,7 +628,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1126
+Defined in src/pools/abstract-pool.ts:622
Protected
Abstract
destroy Worker
@@ -659,7 +659,7 @@ Can be overridden.
Returns void | Promise < void >
+Defined in src/pools/abstract-pool.ts:643
+Defined in src/pools/abstract-pool.ts:527
Private
enqueue Task
@@ -699,7 +699,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1122
+Defined in src/pools/abstract-pool.ts:587
Private
execute Task
@@ -740,7 +740,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:1117
Private
flush Tasks Queue
@@ -753,7 +753,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1134
Private
flush Tasks Queues
@@ -761,7 +761,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1144
Private
get Worker By Id
@@ -781,7 +781,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:468
Private
get Worker Info
@@ -800,7 +800,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1090
Private
get Worker Node Key
@@ -820,7 +820,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:490
Private
handle Task Execution Response
@@ -833,7 +833,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1047
Private
handle Worker Ready Message
@@ -846,7 +846,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1038
Protected
internal Busy
@@ -858,7 +858,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:578
Protected
Abstract
is Main
@@ -869,7 +869,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:658
Private
push Worker Node
@@ -889,7 +889,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1100
Private
redistribute Queued Tasks
@@ -902,7 +902,7 @@ Can be overridden.
worker : Worker
Returns void
+Defined in src/pools/abstract-pool.ts:961
Private
register Worker Message Listener
@@ -942,7 +942,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:891
Private
remove Worker Node
@@ -961,7 +961,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1109
Protected
Abstract
send To Worker
@@ -985,7 +985,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:880
+Defined in src/pools/abstract-pool.ts:539
+Defined in src/pools/abstract-pool.ts:497
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:516
Private
set Worker Statistics
@@ -1063,7 +1063,7 @@ Can be overridden.
worker : Worker
Returns void
+Defined in src/pools/abstract-pool.ts:1150
Protected
setup Hook
@@ -1075,7 +1075,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:651
Private
shall Create Dynamic Worker
@@ -1087,7 +1087,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:870
Private
tasks Queue Size
@@ -1100,7 +1100,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1130
Private
update Elu Worker Usage
@@ -1115,7 +1115,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:782
Private
update Run Time Worker Usage
@@ -1130,7 +1130,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:706
Private
update Task Statistics Worker Usage
@@ -1145,7 +1145,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:693
Private
update Wait Time Worker Usage
@@ -1160,7 +1160,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:744
Protected
worker Listener
@@ -1187,7 +1187,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1025
+Defined in src/worker/abstract-worker.ts:70
Protected
last Task Timestamp
last Task Timestamp : number
@@ -177,7 +177,7 @@
+Defined in src/worker/abstract-worker.ts:50
Protected
Readonly
main Worker
main Worker : MainWorker
@@ -185,7 +185,7 @@
+Defined in src/worker/abstract-worker.ts:74
Protected
Readonly
opts
@@ -193,7 +193,7 @@
+Defined in src/worker/abstract-worker.ts:75
Protected
statistics
@@ -201,7 +201,7 @@
+Defined in src/worker/abstract-worker.ts:54
Protected
task Functions
@@ -209,7 +209,7 @@
+Defined in src/worker/abstract-worker.ts:46
bind
@@ -268,7 +268,7 @@
Returns void
+Defined in src/worker/abstract-worker.ts:203
Private
check Statistics
@@ -276,7 +276,7 @@
Returns void
+Defined in src/worker/abstract-worker.ts:358
Private
check Task Functions
@@ -295,7 +295,7 @@
Returns void
+Defined in src/worker/abstract-worker.ts:107
Private
check Worker Options
Returns void
+Defined in src/worker/abstract-worker.ts:95
emit Destroy
@@ -337,7 +337,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:343
Protected
get Main Worker
@@ -349,7 +349,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:217
Private
get Task Function
@@ -368,7 +368,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:326
Protected
handle Error
@@ -388,7 +388,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:239
Protected
message Listener
@@ -407,7 +407,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:147
Protected
run Async
@@ -431,7 +431,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:286
run In Async Scope
@@ -510,7 +510,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:249
Protected
Abstract
send To Main Worker
@@ -529,7 +529,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:229
Private
start Check Alive
@@ -540,7 +540,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:184
Private
stop Check Alive
@@ -551,7 +551,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:196
trigger Async Id
@@ -573,7 +573,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:177
Static
bind
diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html
index 1929f516..17e9670a 100644
--- a/docs/classes/CircularArray.html
+++ b/docs/classes/CircularArray.html
@@ -31,7 +31,7 @@
+Defined in src/circular-array.ts:8
+Defined in src/circular-array.ts:11
Properties
@@ -153,7 +153,7 @@ when they will be absent when used in a 'with' statement.
size
size : number
+Defined in src/circular-array.ts:9
Static
Readonly
[species]
[species] : ArrayConstructor
@@ -206,7 +206,7 @@ when they will be absent when used in a 'with' statement.
size : number
Returns void
+Defined in src/circular-array.ts:88
concat
@@ -222,7 +222,7 @@ when they will be absent when used in a 'with' statement.
Inherit Doc
+Defined in src/circular-array.ts:39
copy Within
@@ -263,7 +263,7 @@ is treated as length+end. If start is omitted, 0
is used.
Returns boolean
+Defined in src/circular-array.ts:80
entries
@@ -729,7 +729,7 @@ thisArg is omitted, undefined is used as the this value.
Returns boolean
+Defined in src/circular-array.ts:84
includes
@@ -910,7 +910,7 @@ If the array is empty, undefined is returned and the array is not modified.
Inherit Doc
+Defined in src/circular-array.ts:21
reduce
@@ -1145,7 +1145,7 @@ If the array is empty, undefined is returned and the array is not modified.
size : number
Returns void
+Defined in src/circular-array.ts:68
reverse
@@ -1301,7 +1301,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
Inherit Doc
+Defined in src/circular-array.ts:54
to Locale String
@@ -1341,7 +1341,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
Inherit Doc
+Defined in src/circular-array.ts:30
values
diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html
index 6182f170..5bb48539 100644
--- a/docs/classes/ClusterWorker.html
+++ b/docs/classes/ClusterWorker.html
@@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/cluster-worker.ts:21
@@ -120,7 +120,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/cluster-worker.ts:31
Protected
Readonly
is Main
is Main : boolean
@@ -140,7 +140,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:70
Protected
last Task Timestamp
last Task Timestamp : number
@@ -149,7 +149,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:50
Protected
Readonly
main Worker
main Worker : Worker
@@ -158,7 +158,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:74
Protected
Readonly
opts
@@ -167,7 +167,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:75
Protected
statistics
@@ -176,7 +176,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:54
Protected
task Functions
@@ -185,7 +185,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:46
Accessors
@@ -199,7 +199,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/cluster-worker.ts:47
+Defined in src/worker/abstract-worker.ts:239
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:147
+Defined in src/worker/abstract-worker.ts:286
+Defined in src/worker/abstract-worker.ts:249
Protected
send To Main Worker
+Defined in src/worker/cluster-worker.ts:52
+Defined in src/worker/abstract-worker.ts:177
Static
bind
diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html
index 56a8c101..9ce4f062 100644
--- a/docs/classes/DynamicClusterPool.html
+++ b/docs/classes/DynamicClusterPool.html
@@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/cluster/dynamic.ts:15
@@ -144,7 +144,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/cluster/dynamic.ts:27
Properties
@@ -163,7 +163,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:58
Protected
Readonly
file Path
file Path : string
@@ -172,7 +172,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:96
Protected
Readonly
max
max : number
@@ -180,7 +180,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/cluster/dynamic.ts:29
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -189,7 +189,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:95
Protected
Readonly
opts
@@ -198,7 +198,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/cluster/fixed.ts:47
Protected
promise Response Map
@@ -212,7 +212,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:68
Protected
worker Choice Strategy Context
@@ -221,7 +221,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:76
Readonly
worker Nodes
@@ -230,7 +230,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:55
+Defined in src/pools/abstract-pool.ts:562
+Defined in src/pools/abstract-pool.ts:268
+Defined in src/pools/cluster/dynamic.ts:43
+Defined in src/pools/cluster/fixed.ts:92
+Defined in src/pools/abstract-pool.ts:412
+Defined in src/pools/abstract-pool.ts:404
+Defined in src/pools/cluster/dynamic.ts:38
+Defined in src/pools/abstract-pool.ts:424
+Defined in src/pools/cluster/fixed.ts:87
Protected
after Worker Setup
+Defined in src/pools/abstract-pool.ts:911
Protected
before Task Execution Hook
+Defined in src/pools/abstract-pool.ts:667
Protected
check Dynamic Pool Size
+Defined in src/pools/abstract-pool.ts:160
Protected
create And Setup Dynamic Worker
+Defined in src/pools/abstract-pool.ts:994
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:928
+Defined in src/pools/cluster/fixed.ts:77
+Defined in src/pools/abstract-pool.ts:622
+Defined in src/pools/cluster/fixed.ts:63
+Defined in src/pools/abstract-pool.ts:527
+Defined in src/pools/abstract-pool.ts:587
+Defined in src/pools/abstract-pool.ts:578
+Defined in src/pools/cluster/fixed.ts:58
+Defined in src/pools/cluster/fixed.ts:72
+Defined in src/pools/abstract-pool.ts:539
+Defined in src/pools/abstract-pool.ts:497
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:516
+Defined in src/pools/cluster/fixed.ts:53
+Defined in src/pools/abstract-pool.ts:1025
+Defined in src/pools/cluster/fixed.ts:22
Optional
tasks Queue Options
@@ -144,7 +144,7 @@
+Defined in src/pools/pool.ts:157
Optional
worker Choice Strategy
worker Choice Strategy ?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -155,7 +155,7 @@
+Defined in src/pools/pool.ts:133
Optional
worker Choice Strategy Options
@@ -164,7 +164,7 @@
+Defined in src/pools/pool.ts:137
+Defined in src/pools/pool.ts:199
Readonly
info
@@ -164,7 +164,7 @@
+Defined in src/pools/pool.ts:175
Readonly
set Tasks Queue Options
set Tasks Queue Options : ( ( tasksQueueOptions ) => void )
@@ -188,7 +188,7 @@
Returns void
+Defined in src/pools/pool.ts:237
Readonly
set Worker Choice Strategy
set Worker Choice Strategy : ( ( workerChoiceStrategy , workerChoiceStrategyOptions ? ) => void )
@@ -217,7 +217,7 @@
Returns void
+Defined in src/pools/pool.ts:210
Readonly
set Worker Choice Strategy Options
set Worker Choice Strategy Options : ( ( workerChoiceStrategyOptions ) => void )
@@ -241,7 +241,7 @@
Returns void
+Defined in src/pools/pool.ts:219
Readonly
worker Nodes
@@ -249,7 +249,7 @@
+Defined in src/pools/pool.ts:179
+Defined in src/pools/worker.ts:218
Optional
Readonly
thread Id
thread Id ?: number
+Defined in src/pools/worker.ts:201
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:186
Readonly
remove
remove : ( ( workerNodeKey ) => boolean )
@@ -83,7 +83,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:193
Readonly
reset
reset : ( ( ) => boolean )
@@ -100,7 +100,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:174
Readonly
set Options
set Options : ( ( opts ) => void )
@@ -124,7 +124,7 @@
Returns void
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:199
Readonly
strategy Policy
@@ -132,7 +132,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:164
Readonly
task Statistics Requirements
@@ -140,7 +140,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:168
Readonly
update
update : ( ( workerNodeKey ) => boolean )
@@ -162,7 +162,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:180
+Defined in src/pools/worker.ts:253
Readonly
info
@@ -121,7 +121,7 @@
+Defined in src/pools/worker.ts:236
Readonly
reset Usage
reset Usage : ( ( ) => void )
@@ -137,7 +137,7 @@
Returns void
+Defined in src/pools/worker.ts:267
Readonly
tasks Queue Size
tasks Queue Size : ( ( ) => number )
@@ -154,7 +154,7 @@
+Defined in src/pools/worker.ts:246
usage
@@ -162,7 +162,7 @@
+Defined in src/pools/worker.ts:240
Readonly
worker
worker : Worker
@@ -170,7 +170,7 @@
+Defined in src/pools/worker.ts:232
+Defined in src/pools/worker.ts:90
Optional
maximum
maximum ?: number
@@ -72,7 +72,7 @@
+Defined in src/pools/worker.ts:78
Optional
median
median ?: number
@@ -80,7 +80,7 @@
+Defined in src/pools/worker.ts:86
Optional
minimum
minimum ?: number
@@ -88,7 +88,7 @@
+Defined in src/pools/worker.ts:74
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:120
+Defined in src/utility-types.ts:79
Optional
Readonly
statistics
@@ -119,7 +119,7 @@
+Defined in src/utility-types.ts:75
Optional
Readonly
task Error
@@ -127,7 +127,7 @@
+Defined in src/utility-types.ts:67
Optional
Readonly
task Performance
@@ -135,7 +135,7 @@
+Defined in src/utility-types.ts:71
Optional
Readonly
timestamp
timestamp ?: number
@@ -144,7 +144,7 @@
+Defined in src/pools/worker.ts:54
Readonly
worker Id
worker Id : number
@@ -153,7 +153,7 @@
+Defined in src/pools/worker.ts:42
+Defined in src/pools/pool.ts:80
Readonly
strategy
strategy : "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+Defined in src/pools/pool.ts:64
Readonly
type
type : "fixed" | "dynamic"
+Defined in src/pools/pool.ts:61
Optional
Readonly
utilization
utilization ?: number
@@ -142,12 +142,12 @@
+Defined in src/pools/pool.ts:68
Readonly
version
version : string
+Defined in src/pools/pool.ts:60
Optional
Readonly
wait Time
wait Time ?: {     average : number ;     maximum : number ;     median ?: number ;     minimum : number ; }
@@ -163,12 +163,12 @@
Readonly
minimum : number
+Defined in src/pools/pool.ts:86
Readonly
worker
worker : "cluster" | "thread"
+Defined in src/pools/pool.ts:62
Readonly
worker Nodes
worker Nodes : number
@@ -176,7 +176,7 @@
+Defined in src/pools/pool.ts:70
+Defined in src/pools/pool.ts:119
Optional
exit Handler
@@ -91,7 +91,7 @@
+Defined in src/pools/pool.ts:127
Optional
message Handler
@@ -99,7 +99,7 @@
+Defined in src/pools/pool.ts:115
Optional
online Handler
@@ -107,7 +107,7 @@
+Defined in src/pools/pool.ts:123
Optional
restart Worker On Error
restart Worker On Error ?: boolean
@@ -115,7 +115,7 @@
+Defined in src/pools/pool.ts:141
Optional
tasks Queue Options
@@ -123,7 +123,7 @@
+Defined in src/pools/pool.ts:157
Optional
worker Choice Strategy
worker Choice Strategy ?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -133,7 +133,7 @@
Default Value WorkerChoiceStrategies.ROUND_ROBIN
+Defined in src/pools/pool.ts:133
Optional
worker Choice Strategy Options
@@ -141,7 +141,7 @@
+Defined in src/pools/pool.ts:137
+Defined in src/utility-types.ts:108
+Defined in src/pools/worker.ts:46
Optional
Readonly
timestamp
timestamp ?: number
@@ -81,7 +81,7 @@
+Defined in src/pools/worker.ts:54
Readonly
worker Id
worker Id : number
@@ -89,7 +89,7 @@
+Defined in src/pools/worker.ts:42
+Defined in src/utility-types.ts:14
+Defined in src/utility-types.ts:30
+Defined in src/pools/worker.ts:129
Readonly
max Queued
max Queued : number
@@ -71,7 +71,7 @@
+Defined in src/pools/worker.ts:125
Readonly
queued
queued : number
@@ -79,7 +79,7 @@
+Defined in src/pools/worker.ts:121
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:136
+Defined in src/pools/pool.ts:133
Optional
worker Choice Strategy Options
@@ -143,7 +143,7 @@
+Defined in src/pools/pool.ts:137
+Defined in src/pools/thread/fixed.ts:21
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:81
Optional
Readonly
wait Time
@@ -77,7 +77,7 @@
Default Value { median: false }
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:87
Optional
Readonly
weights
weights ?: Record < number , number >
@@ -88,7 +88,7 @@ Weight is the tasks maximum average or median runtime in milliseconds.
Default Value Computed worker weights automatically given the CPU performance.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:100
+Defined in src/pools/worker.ts:166
type
type : "cluster" | "thread"
@@ -70,7 +70,7 @@
+Defined in src/pools/worker.ts:158
+Defined in src/worker/worker-options.ts:36
+Defined in src/pools/worker.ts:186
Worker choice strategy interface.