From 2624da4d8f724e8bc0b655cddfc6ba5ae9a4d053 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Mon, 3 Jul 2023 12:10:15 +0000
Subject: [PATCH] chore: generate documentation
---
docs/classes/AbstractPool.html | 138 +++++++++---------
docs/classes/AbstractWorker.html | 46 +++---
docs/classes/CircularArray.html | 22 +--
docs/classes/ClusterWorker.html | 34 ++---
docs/classes/DynamicClusterPool.html | 74 +++++-----
docs/classes/DynamicThreadPool.html | 74 +++++-----
docs/classes/FixedClusterPool.html | 72 ++++-----
docs/classes/FixedThreadPool.html | 72 ++++-----
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 | 16 +-
docs/interfaces/MeasurementOptions.html | 4 +-
docs/interfaces/MeasurementStatistics.html | 10 +-
.../MeasurementStatisticsRequirements.html | 8 +-
docs/interfaces/MessageValue.html | 22 +--
docs/interfaces/PoolInfo.html | 34 ++---
docs/interfaces/PoolOptions.html | 22 +--
docs/interfaces/PromiseResponseWrapper.html | 8 +-
docs/interfaces/StrategyPolicy.html | 4 +-
docs/interfaces/Task.html | 10 +-
docs/interfaces/TaskError.html | 8 +-
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 | 6 +-
docs/interfaces/WorkerNode.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, 485 insertions(+), 485 deletions(-)
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 6e4b7c70..e8cc3a66 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
@@ -174,7 +174,7 @@
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:94
Protected
Readonly
file Path
file Path : string
@@ -200,7 +200,7 @@
+Defined in src/pools/abstract-pool.ts:96
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -208,7 +208,7 @@
+Defined in src/pools/abstract-pool.ts:95
Protected
Readonly
opts
@@ -216,7 +216,7 @@
+Defined in src/pools/abstract-pool.ts:97
Protected
promise Response Map
@@ -229,7 +229,7 @@
+Defined in src/pools/abstract-pool.ts:68
Private
Readonly
start Timestamp
start Timestamp : number
@@ -237,7 +237,7 @@
+Defined in src/pools/abstract-pool.ts:85
Protected
worker Choice Strategy Context
@@ -245,7 +245,7 @@
+Defined in src/pools/abstract-pool.ts:76
Readonly
worker Nodes
@@ -254,7 +254,7 @@
+Defined in src/pools/abstract-pool.ts:55
Protected
full
@@ -280,7 +280,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:444
+Defined in src/pools/abstract-pool.ts:250
Protected
Abstract
max Size
@@ -303,7 +303,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:350
Protected
Abstract
min Size
@@ -314,7 +314,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:345
+Defined in src/pools/abstract-pool.ts:306
Protected
Abstract
type
@@ -338,7 +338,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:335
+Defined in src/pools/abstract-pool.ts:315
Protected
Abstract
worker
@@ -361,7 +361,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:340
Protected
after Worker Setup
@@ -408,7 +408,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:750
Protected
before Task Execution Hook
@@ -433,7 +433,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:542
Private
build Tasks Queue Options
@@ -446,7 +446,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:431
Private
check And Emit Events
@@ -454,7 +454,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:872
Private
check File Path
@@ -467,7 +467,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:133
Private
check Number Of Workers
@@ -480,7 +480,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:142
Private
check Pool Options
@@ -493,7 +493,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:160
Private
check Valid Tasks Queue Options
@@ -506,7 +506,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:225
Private
check Valid Worker Choice Strategy
@@ -519,7 +519,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:187
Private
check Valid Worker Choice Strategy Options
@@ -532,7 +532,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:197
Private
choose Worker Node
@@ -545,7 +545,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:692
Protected
create And Setup Dynamic Worker
@@ -557,7 +557,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:793
Protected
create And Setup Worker
@@ -569,7 +569,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:760
Protected
Abstract
create Worker
@@ -581,7 +581,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:742
Private
dequeue Task
@@ -594,7 +594,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:977
+Defined in src/pools/abstract-pool.ts:503
Protected
Abstract
destroy Worker
@@ -625,7 +625,7 @@ Can be overridden.
Returns void | Promise < void >
+Defined in src/pools/abstract-pool.ts:518
+Defined in src/pools/abstract-pool.ts:409
Private
enqueue Task
@@ -665,7 +665,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:973
+Defined in src/pools/abstract-pool.ts:469
Private
execute Task
@@ -706,7 +706,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:968
Private
flush Tasks Queue
@@ -719,7 +719,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:989
Private
flush Tasks Queues
@@ -727,7 +727,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1001
Private
get Worker By Id
@@ -747,7 +747,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:358
Private
get Worker Id
@@ -767,7 +767,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:923
Private
get Worker Node Key
@@ -787,7 +787,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:369
Private
get Worker Usage
@@ -800,7 +800,7 @@ Can be overridden.
Optional
workerNodeKey : number
+Defined in src/pools/abstract-pool.ts:1019
Private
handle Task Execution Response
@@ -813,7 +813,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:845
Private
handle Worker Started Message
@@ -826,7 +826,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:830
Protected
internal Busy
@@ -838,7 +838,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:460
Protected
Abstract
is Main
@@ -849,7 +849,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:533
Private
push Worker Node
@@ -869,7 +869,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:902
Private
register Worker Message Listener
@@ -909,7 +909,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:730
Private
remove Worker Node
@@ -928,7 +928,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:960
Protected
Abstract
send To Worker
@@ -952,7 +952,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:719
+Defined in src/pools/abstract-pool.ts:421
+Defined in src/pools/abstract-pool.ts:376
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:398
Private
set Worker Node Tasks Usage
@@ -1041,7 +1041,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:889
Private
set Worker Statistics
@@ -1054,7 +1054,7 @@ Can be overridden.
worker : Worker
Returns void
+Defined in src/pools/abstract-pool.ts:1007
Protected
setup Hook
@@ -1066,7 +1066,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:526
Private
shall Create Dynamic Worker
@@ -1078,7 +1078,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:709
Private
tasks Max Queue Size
@@ -1091,7 +1091,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:985
Private
tasks Queue Size
@@ -1104,7 +1104,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:981
Private
update Elu Worker Usage
@@ -1119,7 +1119,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:640
Private
update Run Time Worker Usage
@@ -1134,7 +1134,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:580
Private
update Task Statistics Worker Usage
@@ -1149,7 +1149,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:568
Private
update Wait Time Worker Usage
@@ -1164,7 +1164,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:609
Protected
worker Listener
@@ -1191,7 +1191,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:818
+Defined in src/worker/abstract-worker.ts:70
Protected
last Task Timestamp
last Task Timestamp : number
@@ -174,7 +174,7 @@
+Defined in src/worker/abstract-worker.ts:50
Protected
Readonly
main Worker
main Worker : MainWorker
@@ -182,7 +182,7 @@
+Defined in src/worker/abstract-worker.ts:74
Protected
Readonly
opts
@@ -190,7 +190,7 @@
+Defined in src/worker/abstract-worker.ts:75
Protected
statistics
@@ -198,7 +198,7 @@
+Defined in src/worker/abstract-worker.ts:54
Protected
task Functions
@@ -206,7 +206,7 @@
+Defined in src/worker/abstract-worker.ts:46
bind
@@ -265,7 +265,7 @@
Returns void
+Defined in src/worker/abstract-worker.ts:196
Private
check Statistics
@@ -273,7 +273,7 @@
Returns void
+Defined in src/worker/abstract-worker.ts:326
Private
check Task Functions
@@ -292,7 +292,7 @@
Returns void
+Defined in src/worker/abstract-worker.ts:113
Private
check Worker Options
Returns void
+Defined in src/worker/abstract-worker.ts:101
emit Destroy
@@ -334,7 +334,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:311
Protected
get Main Worker
@@ -346,7 +346,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:177
Private
get Task Function
@@ -365,7 +365,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:294
Protected
handle Error
@@ -385,7 +385,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:211
Protected
message Listener
@@ -404,7 +404,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:153
Protected
run Async
@@ -428,7 +428,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:256
run In Async Scope
@@ -507,7 +507,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:221
Protected
Abstract
send To Main Worker
@@ -526,7 +526,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:189
trigger Async Id
diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html
index 274ed3a0..853a70f3 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 6bc8cd98..403c57d5 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:177
+Defined in src/worker/abstract-worker.ts:211
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:153
+Defined in src/worker/abstract-worker.ts:256
+Defined in src/worker/abstract-worker.ts:221
Protected
send To Main Worker
+Defined in src/worker/cluster-worker.ts:52
trigger Async Id
diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html
index 1252ca03..981f3288 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
@@ -142,7 +142,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
@@ -160,7 +160,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
@@ -169,7 +169,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
@@ -177,7 +177,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
@@ -186,7 +186,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:95
Protected
Readonly
opts
@@ -195,7 +195,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/cluster/fixed.ts:52
Protected
promise Response Map
@@ -209,7 +209,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
@@ -218,7 +218,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
@@ -227,7 +227,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:55
+Defined in src/pools/abstract-pool.ts:444
+Defined in src/pools/abstract-pool.ts:250
+Defined in src/pools/cluster/dynamic.ts:42
+Defined in src/pools/cluster/fixed.ts:97
+Defined in src/pools/abstract-pool.ts:306
+Defined in src/pools/cluster/dynamic.ts:37
+Defined in src/pools/abstract-pool.ts:315
+Defined in src/pools/cluster/fixed.ts:92
Protected
after Worker Setup
+Defined in src/pools/abstract-pool.ts:750
Protected
before Task Execution Hook
+Defined in src/pools/abstract-pool.ts:542
Protected
create And Setup Dynamic Worker
+Defined in src/pools/abstract-pool.ts:793
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:760
+Defined in src/pools/cluster/fixed.ts:82
+Defined in src/pools/abstract-pool.ts:503
+Defined in src/pools/cluster/fixed.ts:68
+Defined in src/pools/abstract-pool.ts:409
+Defined in src/pools/abstract-pool.ts:469
+Defined in src/pools/abstract-pool.ts:460
+Defined in src/pools/cluster/fixed.ts:63
+Defined in src/pools/cluster/fixed.ts:77
+Defined in src/pools/abstract-pool.ts:421
+Defined in src/pools/abstract-pool.ts:376
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:398
+Defined in src/pools/cluster/fixed.ts:58
+Defined in src/pools/abstract-pool.ts:818
+Defined in src/pools/cluster/fixed.ts:27
Optional
tasks Queue Options
@@ -144,7 +144,7 @@
+Defined in src/pools/pool.ts:153
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:129
Optional
worker Choice Strategy Options
@@ -164,7 +164,7 @@
+Defined in src/pools/pool.ts:133
+Defined in src/pools/pool.ts:194
Readonly
info
@@ -163,7 +163,7 @@
+Defined in src/pools/pool.ts:171
set Tasks Queue Options
set Tasks Queue Options : ( ( tasksQueueOptions ) => void )
@@ -187,7 +187,7 @@
Returns void
+Defined in src/pools/pool.ts:232
set Worker Choice Strategy
set Worker Choice Strategy : ( ( workerChoiceStrategy , workerChoiceStrategyOptions ? ) => void )
@@ -216,7 +216,7 @@
Returns void
+Defined in src/pools/pool.ts:205
set Worker Choice Strategy Options
set Worker Choice Strategy Options : ( ( workerChoiceStrategyOptions ) => void )
@@ -240,7 +240,7 @@
Returns void
+Defined in src/pools/pool.ts:214
Readonly
worker Nodes
@@ -248,7 +248,7 @@
+Defined in src/pools/pool.ts:175
+Defined in src/pools/worker.ts:186
Optional
Readonly
thread Id
thread Id ?: number
+Defined in src/pools/worker.ts:169
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:172
set Options
set Options : ( ( opts ) => void )
@@ -124,7 +124,7 @@
Returns void
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:197
Readonly
strategy Policy
@@ -132,7 +132,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:162
Readonly
task Statistics Requirements
@@ -140,7 +140,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:166
update
update : ( ( workerNodeKey ) => boolean )
@@ -162,7 +162,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:178
+Defined in src/pools/worker.ts:79
median
median : number
@@ -70,7 +70,7 @@
+Defined in src/pools/worker.ts:75
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:120
+Defined in src/utility-types.ts:83
Optional
Readonly
task Error
@@ -118,7 +118,7 @@
+Defined in src/utility-types.ts:75
Optional
Readonly
task Performance
@@ -126,7 +126,7 @@
+Defined in src/utility-types.ts:79
Optional
Readonly
timestamp
timestamp ?: number
@@ -135,7 +135,7 @@
+Defined in src/pools/worker.ts:51
Optional
Readonly
worker Id
worker Id ?: number
@@ -143,7 +143,7 @@
+Defined in src/utility-types.ts:67
+Defined in src/pools/pool.ts:82
executed Tasks
executed Tasks : number
+Defined in src/pools/pool.ts:83
executing Tasks
executing Tasks : number
+Defined in src/pools/pool.ts:84
failed Tasks
failed Tasks : number
+Defined in src/pools/pool.ts:87
idle Worker Nodes
idle Worker Nodes : number
@@ -78,45 +78,45 @@
+Defined in src/pools/pool.ts:80
max Queued Tasks
max Queued Tasks : number
+Defined in src/pools/pool.ts:86
+Defined in src/pools/pool.ts:74
+Defined in src/pools/pool.ts:73
queued Tasks
queued Tasks : number
+Defined in src/pools/pool.ts:85
type
type : "fixed" | "dynamic"
+Defined in src/pools/pool.ts:71
-utilization
-utilization : number
+Optional
utilization
+utilization ?: number
+Defined in src/pools/pool.ts:76
worker
worker : "cluster" | "thread"
+Defined in src/pools/pool.ts:72
worker Nodes
worker Nodes : number
@@ -124,7 +124,7 @@
+Defined in src/pools/pool.ts:78
+Defined in src/pools/pool.ts:115
Optional
exit Handler
@@ -91,7 +91,7 @@
+Defined in src/pools/pool.ts:123
Optional
message Handler
@@ -99,7 +99,7 @@
+Defined in src/pools/pool.ts:111
Optional
online Handler
@@ -107,7 +107,7 @@
+Defined in src/pools/pool.ts:119
Optional
restart Worker On Error
restart Worker On Error ?: boolean
@@ -115,7 +115,7 @@
+Defined in src/pools/pool.ts:137
Optional
tasks Queue Options
@@ -123,7 +123,7 @@
+Defined in src/pools/pool.ts:153
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:129
Optional
worker Choice Strategy Options
@@ -141,7 +141,7 @@
+Defined in src/pools/pool.ts:133
+Defined in src/utility-types.ts:112
+Defined in src/pools/worker.ts:43
Optional
Readonly
timestamp
timestamp ?: number
@@ -80,7 +80,7 @@
+Defined in src/pools/worker.ts:51
+Defined in src/utility-types.ts:14
+Defined in src/utility-types.ts:34
+Defined in src/pools/worker.ts:118
Readonly
max Queued
max Queued : number
@@ -71,7 +71,7 @@
+Defined in src/pools/worker.ts:114
Readonly
queued
queued : number
@@ -79,7 +79,7 @@
+Defined in src/pools/worker.ts:110
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:136
+Defined in src/pools/pool.ts:129
Optional
worker Choice Strategy Options
@@ -143,7 +143,7 @@
+Defined in src/pools/pool.ts:133
+Defined in src/pools/thread/fixed.ts:26
+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:134
+Defined in src/pools/worker.ts:208
Readonly
worker
worker : Worker
@@ -83,7 +83,7 @@
+Defined in src/pools/worker.ts:200
+Defined in src/worker/worker-options.ts:36
+Defined in src/pools/worker.ts:154
Pool utilization ratio.