From 010ae1ba98e5ab018fa09870982d511c9389b48b Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Mon, 28 Aug 2023 18:41:47 +0000
Subject: [PATCH] chore: generate documentation
---
docs/classes/AbstractPool.html | 172 +++++++++---------
docs/classes/AbstractWorker.html | 78 ++++----
docs/classes/CircularArray.html | 22 +--
docs/classes/ClusterWorker.html | 52 +++---
docs/classes/Deque.html | 32 ++--
docs/classes/DynamicClusterPool.html | 90 ++++-----
docs/classes/DynamicThreadPool.html | 90 ++++-----
docs/classes/FixedClusterPool.html | 90 ++++-----
docs/classes/FixedThreadPool.html | 90 ++++-----
docs/classes/Node.html | 10 +-
docs/classes/PoolEmitter.html | 2 +-
docs/classes/ThreadWorker.html | 54 +++---
docs/classes/WorkerChoiceStrategyContext.html | 26 +--
docs/functions/availableParallelism.html | 2 +-
docs/interfaces/ClusterPoolOptions.html | 26 +--
...tLoopUtilizationMeasurementStatistics.html | 8 +-
docs/interfaces/IPool.html | 24 +--
docs/interfaces/IWorker.html | 10 +-
docs/interfaces/IWorkerChoiceStrategy.html | 16 +-
docs/interfaces/IWorkerNode.html | 36 ++--
docs/interfaces/MeasurementOptions.html | 4 +-
docs/interfaces/MeasurementStatistics.html | 14 +-
.../MeasurementStatisticsRequirements.html | 8 +-
docs/interfaces/MessageValue.html | 30 +--
docs/interfaces/PoolInfo.html | 42 ++---
docs/interfaces/PoolOptions.html | 22 +--
docs/interfaces/PromiseResponseWrapper.html | 8 +-
docs/interfaces/StrategyPolicy.html | 6 +-
docs/interfaces/Task.html | 14 +-
docs/interfaces/TaskError.html | 8 +-
docs/interfaces/TaskPerformance.html | 10 +-
docs/interfaces/TaskStatistics.html | 14 +-
.../TaskStatisticsRequirements.html | 8 +-
docs/interfaces/TasksQueueOptions.html | 8 +-
docs/interfaces/ThreadPoolOptions.html | 24 +--
.../WorkerChoiceStrategyOptions.html | 14 +-
docs/interfaces/WorkerInfo.html | 12 +-
docs/interfaces/WorkerOptions.html | 10 +-
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/KillHandler.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/TaskAsyncFunction.html | 2 +-
docs/types/TaskFunction.html | 2 +-
docs/types/TaskFunctions.html | 2 +-
docs/types/TaskSyncFunction.html | 2 +-
docs/types/WorkerChoiceStrategy.html | 2 +-
docs/types/WorkerNodeEventCallback.html | 2 +-
docs/types/WorkerType.html | 2 +-
docs/types/Writable.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 +-
63 files changed, 627 insertions(+), 621 deletions(-)
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 779ee936..1d9b8d8b 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:57
@@ -188,7 +188,7 @@
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:113
Protected
Readonly
file Path
file Path : string
@@ -217,7 +217,7 @@
+Defined in src/pools/abstract-pool.ts:115
Protected
Optional
Readonly
max
max ?: number
@@ -225,7 +225,7 @@
+Defined in src/pools/abstract-pool.ts:91
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -233,7 +233,7 @@
+Defined in src/pools/abstract-pool.ts:114
Protected
Readonly
opts
@@ -241,7 +241,7 @@
+Defined in src/pools/abstract-pool.ts:116
Protected
promise Response Map
@@ -254,7 +254,7 @@
+Defined in src/pools/abstract-pool.ts:76
Private
Readonly
start Timestamp
start Timestamp : number
@@ -262,7 +262,7 @@
+Defined in src/pools/abstract-pool.ts:104
Private
started
started : boolean
@@ -270,7 +270,7 @@
+Defined in src/pools/abstract-pool.ts:100
Private
Readonly
starting
starting : boolean
@@ -278,7 +278,7 @@
+Defined in src/pools/abstract-pool.ts:96
Protected
worker Choice Strategy Context
@@ -286,7 +286,7 @@
+Defined in src/pools/abstract-pool.ts:82
Readonly
Internal
worker Nodes
@@ -295,7 +295,7 @@
+Defined in src/pools/abstract-pool.ts:63
Protected
full
@@ -321,7 +321,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:687
+Defined in src/pools/abstract-pool.ts:348
Protected
max Size
@@ -344,7 +344,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:560
Protected
min Size
@@ -355,7 +355,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:553
Private
ready
@@ -366,7 +366,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:505
Protected
Abstract
type
@@ -378,7 +378,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:543
+Defined in src/pools/abstract-pool.ts:522
Protected
Abstract
worker
@@ -401,7 +401,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:548
Protected
after Task Execution Hook
@@ -447,7 +447,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:886
Protected
after Worker Node Setup
@@ -466,7 +466,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1160
Protected
before Task Execution Hook
@@ -489,7 +489,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:856
Private
build Tasks Queue Options
@@ -502,7 +502,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:670
Private
check And Emit Dynamic Worker Creation Events
@@ -510,7 +510,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1402
Private
check And Emit Task Execution Events
@@ -518,7 +518,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1390
Private
check And Emit Task Queuing Events
@@ -526,7 +526,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1396
Protected
check Dynamic Pool Size
@@ -541,7 +541,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:185
Private
check File Path
@@ -554,7 +554,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:154
Private
check Message Worker Id
+Defined in src/pools/abstract-pool.ts:570
Private
check Number Of Workers
@@ -587,7 +587,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:167
Private
check Pool Options
@@ -600,7 +600,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:211
Private
check Valid Tasks Queue Options
@@ -613,7 +613,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:293
Private
check Valid Worker Choice Strategy
@@ -626,7 +626,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:239
Private
check Valid Worker Choice Strategy Options
@@ -639,7 +639,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:249
Private
choose Worker Node
@@ -652,7 +652,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1013
Protected
create And Setup Dynamic Worker Node
@@ -664,7 +664,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1103
Protected
create And Setup Worker Node
@@ -676,7 +676,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1059
Protected
Abstract
create Worker
@@ -688,7 +688,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1052
Private
dequeue Task
@@ -701,7 +701,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1492
+Defined in src/pools/abstract-pool.ts:801
Protected
Abstract
destroy Worker Node
@@ -731,7 +731,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:832
+Defined in src/pools/abstract-pool.ts:641
Private
enqueue Task
@@ -769,7 +769,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1486
+Defined in src/pools/abstract-pool.ts:745
Private
execute Task
@@ -819,7 +819,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1480
Protected
flush Tasks Queue
@@ -832,7 +832,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1500
Private
flush Tasks Queues
@@ -840,7 +840,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1510
Protected
get Worker Info
@@ -859,7 +859,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1416
Private
get Worker Node Key By Worker
@@ -878,7 +878,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:589
Private
get Worker Node Key By Worker Id
@@ -897,7 +897,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:601
Private
handle Task Execution Response
@@ -910,7 +910,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1362
Private
handle Worker Ready Response
@@ -923,7 +923,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1348
Private
has Back Pressure
@@ -931,7 +931,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1465
has Worker Node Back Pressure
+Defined in src/pools/abstract-pool.ts:1458
Protected
internal Busy
@@ -963,7 +963,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:703
Protected
Abstract
is Main
@@ -974,7 +974,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:847
+Defined in src/pools/abstract-pool.ts:724
Private
redistribute Queued Tasks
@@ -1000,7 +1000,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1200
Protected
Abstract
register Worker Message Listener
@@ -1038,7 +1038,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1147
Private
remove Worker Node
@@ -1056,7 +1056,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1449
Protected
send Kill Message To Worker
@@ -1071,7 +1071,7 @@ Can be overridden.
workerId : number
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:811
Protected
Abstract
send Startup Message To Worker
@@ -1089,7 +1089,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1180
Private
send Statistics Message To Worker
@@ -1107,7 +1107,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1187
Protected
Abstract
send To Worker
@@ -1133,7 +1133,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1041
Private
set Tasks Queue Max Size
@@ -1146,7 +1146,7 @@ Can be overridden.
size : number
Returns void
+Defined in src/pools/abstract-pool.ts:664
+Defined in src/pools/abstract-pool.ts:653
+Defined in src/pools/abstract-pool.ts:608
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:627
Protected
setup Hook
@@ -1219,7 +1219,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:840
Private
shall Create Dynamic Worker
@@ -1231,7 +1231,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1030
Private
shall Execute Task
@@ -1244,7 +1244,7 @@ Can be overridden.
workerNodeKey : number
Returns boolean
+Defined in src/pools/abstract-pool.ts:736
Private
shall Update Task Function Worker Usage
@@ -1263,7 +1263,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:919
Private
start Pool
@@ -1271,7 +1271,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:335
Private
task Stealing On Empty Queue
@@ -1284,7 +1284,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1250
Private
tasks Queue Size
@@ -1297,7 +1297,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1496
Private
tasks Stealing On Back Pressure
@@ -1310,7 +1310,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1286
Private
update Elu Worker Usage
@@ -1325,7 +1325,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:973
Private
update Run Time Worker Usage
@@ -1340,7 +1340,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:946
Private
update Task Statistics Worker Usage
@@ -1355,7 +1355,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:928
Private
update Task Stolen Statistics Worker Usage
@@ -1370,7 +1370,7 @@ Can be overridden.
taskName : string
Returns void
+Defined in src/pools/abstract-pool.ts:1231
Private
update Wait Time Worker Usage
@@ -1385,7 +1385,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:960
Protected
worker Listener
@@ -1412,7 +1412,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1328
+Defined in src/worker/abstract-worker.ts:85
Protected
last Task Timestamp
last Task Timestamp : number
@@ -183,7 +183,7 @@
+Defined in src/worker/abstract-worker.ts:65
Private
Readonly
main Worker
main Worker : MainWorker
@@ -191,7 +191,7 @@
+Defined in src/worker/abstract-worker.ts:86
Protected
opts
@@ -199,7 +199,7 @@
+Defined in src/worker/abstract-worker.ts:88
Protected
statistics
@@ -207,7 +207,7 @@
+Defined in src/worker/abstract-worker.ts:69
Protected
task Functions
@@ -215,7 +215,7 @@
+Defined in src/worker/abstract-worker.ts:61
async Id
@@ -271,7 +271,7 @@ If a task function with the same name already exists, it is replaced.
Optional
name : string Optional
+Defined in src/worker/abstract-worker.ts:576
bind
@@ -308,7 +308,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:419
Private
check Message Worker Id
+Defined in src/worker/abstract-worker.ts:385
Private
check Statistics
@@ -336,7 +336,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:600
Private
check Task Function Name
@@ -349,7 +349,7 @@ If a task function with the same name already exists, it is replaced.
name : string
Returns void
+Defined in src/worker/abstract-worker.ts:308
Private
check Task Functions
@@ -367,7 +367,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:132
Private
check Valid Task Function
@@ -382,7 +382,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:106
Private
check Worker Options
@@ -395,7 +395,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:101
emit Destroy
@@ -424,7 +424,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:585
+Defined in src/worker/abstract-worker.ts:434
Protected
handle Error
@@ -455,7 +457,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:466
Protected
handle Kill Message
@@ -473,7 +475,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:351
Protected
Abstract
handle Ready Message
@@ -491,7 +493,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:322
+Defined in src/worker/abstract-worker.ts:177
list Task Functions
@@ -524,7 +526,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:255
Protected
message Listener
@@ -542,7 +544,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:329
+Defined in src/worker/abstract-worker.ts:231
+Defined in src/worker/abstract-worker.ts:476
Protected
run Async
@@ -609,7 +611,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:541
run In Async Scope
@@ -683,7 +685,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:504
Protected
send Task Functions List To Main Worker
@@ -694,7 +696,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:453
Protected
Abstract
send To Main Worker
@@ -712,7 +714,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:446
+Defined in src/worker/abstract-worker.ts:285
Private
start Check Active
@@ -748,7 +750,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:398
Private
stop Check Active
@@ -759,7 +761,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:409
trigger Async Id
@@ -778,7 +780,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:606
Static
bind
diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html
index b1264a50..9e6e21fb 100644
--- a/docs/classes/CircularArray.html
+++ b/docs/classes/CircularArray.html
@@ -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
@@ -205,7 +205,7 @@ when they will be absent when used in a 'with' statement.
size : number
Returns void
+Defined in src/circular-array.ts:100
concat
@@ -221,7 +221,7 @@ when they will be absent when used in a 'with' statement.
Inherit Doc
+Defined in src/circular-array.ts:41
copy Within
@@ -259,7 +259,7 @@ is treated as length+end.
Returns boolean
+Defined in src/circular-array.ts:92
entries
@@ -705,7 +705,7 @@ thisArg is omitted, undefined is used as the this value.
Returns boolean
+Defined in src/circular-array.ts:96
includes
@@ -877,7 +877,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
@@ -1106,7 +1106,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
@@ -1257,7 +1257,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
Inherit Doc
+Defined in src/circular-array.ts:56
to Locale String
@@ -1297,7 +1297,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
Inherit Doc
+Defined in src/circular-array.ts:32
values
diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html
index b6d8cb5a..457a1629 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
@@ -125,7 +125,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
@@ -145,7 +145,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:85
Protected
last Task Timestamp
last Task Timestamp : number
@@ -154,7 +154,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:65
Protected
opts
@@ -163,7 +163,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:88
Protected
statistics
@@ -172,7 +172,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:69
Protected
task Functions
@@ -181,7 +181,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:61
Accessors
@@ -195,7 +195,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/cluster-worker.ts:65
+Defined in src/worker/abstract-worker.ts:434
+Defined in src/worker/abstract-worker.ts:466
Protected
handle Kill Message
+Defined in src/worker/abstract-worker.ts:351
Protected
handle Ready Message
+Defined in src/worker/cluster-worker.ts:45
+Defined in src/worker/abstract-worker.ts:177
+Defined in src/worker/abstract-worker.ts:255
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:329
+Defined in src/worker/abstract-worker.ts:231
+Defined in src/worker/abstract-worker.ts:476
+Defined in src/worker/abstract-worker.ts:541
+Defined in src/worker/abstract-worker.ts:504
Protected
send Task Functions List To Main Worker
+Defined in src/worker/abstract-worker.ts:453
Protected
send To Main Worker
+Defined in src/worker/cluster-worker.ts:70
+Defined in src/worker/abstract-worker.ts:285
trigger Async Id
diff --git a/docs/classes/Deque.html b/docs/classes/Deque.html
index ed75b497..18fef84c 100644
--- a/docs/classes/Deque.html
+++ b/docs/classes/Deque.html
@@ -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
max Size
max Size : 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
increment Size
@@ -154,7 +154,7 @@ Implemented with a doubly linked list.
Returns number
+Defined in src/deque.ts:194
peek First
@@ -166,7 +166,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:116
peek Last
@@ -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
@@ -209,7 +209,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:44
shift
@@ -221,7 +221,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:97
unshift
@@ -240,7 +240,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:61
+Defined in src/worker/abstract-worker.ts:285
trigger Async Id
diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html
index 5412967a..65a8aed6 100644
--- a/docs/classes/WorkerChoiceStrategyContext.html
+++ b/docs/classes/WorkerChoiceStrategyContext.html
@@ -42,7 +42,7 @@
WorkerChoiceStrategyContext
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:27
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:49
Private
retries Count
retries Count : number = 0
@@ -123,12 +123,12 @@
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:40
Private
Readonly
worker Choice Strategies
worker Choice Strategies : 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
worker Choice Strategy
worker Choice Strategy : "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
@@ -136,7 +136,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
get Task Statistics Requirements
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:132
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:200
set Options
@@ -213,7 +213,7 @@
Returns void
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:213
set Worker Choice Strategy
@@ -231,7 +231,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
+Defined in src/pools/cluster/fixed.ts:22
Optional
tasks Queue Options
@@ -146,7 +146,7 @@
+Defined in src/pools/pool.ts:172
Optional
worker Choice Strategy
worker Choice Strategy ?: "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:148
Optional
worker Choice Strategy Options
@@ -167,7 +167,7 @@
+Defined in src/pools/pool.ts:152
+Defined in src/pools/pool.ts:227
Readonly
has Worker Node Back Pressure
has Worker Node Back Pressure : ( ( workerNodeKey ) => boolean )
@@ -184,7 +184,7 @@
+Defined in src/pools/pool.ts:204
Readonly
info
@@ -192,7 +192,7 @@
+Defined in src/pools/pool.ts:190
Readonly
list Task Functions
list Task Functions : ( ( ) => string [] )
@@ -209,7 +209,7 @@
+Defined in src/pools/pool.ts:241
Readonly
set Tasks Queue Options
set Tasks Queue Options : ( ( tasksQueueOptions ) => void )
@@ -232,7 +232,7 @@
Returns void
+Defined in src/pools/pool.ts:275
Readonly
set Worker Choice Strategy
set Worker Choice Strategy : ( ( workerChoiceStrategy , workerChoiceStrategyOptions ? ) => void )
@@ -259,7 +259,7 @@
Returns void
+Defined in src/pools/pool.ts:248
Readonly
set Worker Choice Strategy Options
set Worker Choice Strategy Options : ( ( workerChoiceStrategyOptions ) => void )
@@ -282,7 +282,7 @@
Returns void
+Defined in src/pools/pool.ts:257
Readonly
Internal
worker Nodes
@@ -290,7 +290,7 @@
+Defined in src/pools/pool.ts:196
+Defined in src/pools/worker.ts:199
Optional
Readonly
thread Id
thread Id ?: number
+Defined in src/pools/worker.ts:182
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:182
Readonly
set Options
set Options : ( ( opts ) => void )
@@ -123,7 +123,7 @@ If the worker node is not eligible, undefined
is returned.
Returns void
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:208
Readonly
strategy Policy
@@ -131,7 +131,7 @@ If the worker node is not eligible, undefined
is returned.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:172
Readonly
task Statistics Requirements
@@ -139,7 +139,7 @@ If the worker node is not eligible, undefined
is returned.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:176
Readonly
update
update : ( ( workerNodeKey ) => boolean )
@@ -161,7 +161,7 @@ If the worker node is not eligible, undefined
is returned.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:188
+Defined in src/pools/worker.ts:270
Readonly
enqueue Task
enqueue Task : ( ( task ) => number )
@@ -137,7 +137,7 @@
+Defined in src/pools/worker.ts:257
Readonly
get Task Function Worker Usage
get Task Function Worker Usage : ( ( name ) => undefined | WorkerUsage )
@@ -161,7 +161,7 @@
+Defined in src/pools/worker.ts:301
Readonly
has Back Pressure
has Back Pressure : ( ( ) => boolean )
@@ -178,7 +178,7 @@
+Defined in src/pools/worker.ts:286
Readonly
info
@@ -186,7 +186,7 @@
+Defined in src/pools/worker.ts:219
Optional
Readonly
message Channel
message Channel ?: MessageChannel
@@ -194,7 +194,7 @@
+Defined in src/pools/worker.ts:227
Optional
on Back Pressure
@@ -204,7 +204,7 @@
Param The worker id.
+Defined in src/pools/worker.ts:238
Optional
on Empty Queue
@@ -214,7 +214,7 @@
Param The worker id.
+Defined in src/pools/worker.ts:244
Readonly
pop Task
pop Task : ( ( ) => undefined | Task < Data > )
@@ -231,7 +231,7 @@
+Defined in src/pools/worker.ts:276
Readonly
reset Usage
reset Usage : ( ( ) => void )
@@ -247,7 +247,7 @@
Returns void
+Defined in src/pools/worker.ts:290
tasks Queue Back Pressure Size
tasks Queue Back Pressure Size : number
@@ -256,7 +256,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:232
Readonly
tasks Queue Size
tasks Queue Size : ( ( ) => number )
@@ -273,7 +273,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:250
Readonly
unshift Task
unshift Task : ( ( task ) => 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:264
usage
@@ -305,7 +305,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:223
Readonly
worker
worker : Worker
@@ -313,7 +313,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:215
+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:124
+Defined in src/utility-types.ts:132
Optional
Readonly
ready
ready ?: boolean
@@ -113,7 +113,7 @@
+Defined in src/utility-types.ts:124
Optional
Readonly
statistics
@@ -121,7 +121,7 @@
+Defined in src/utility-types.ts:120
Optional
Readonly
task Error
@@ -129,7 +129,7 @@
+Defined in src/utility-types.ts:108
Optional
Readonly
task Functions
task Functions ?: string []
@@ -137,7 +137,7 @@
+Defined in src/utility-types.ts:116
Optional
Readonly
task Id
task Id ?: string
@@ -146,7 +146,7 @@
+Defined in src/utility-types.ts:89
Optional
Readonly
task Performance
@@ -154,7 +154,7 @@
+Defined in src/utility-types.ts:112
Optional
Readonly
timestamp
timestamp ?: number
@@ -163,7 +163,7 @@
+Defined in src/utility-types.ts:85
Optional
Readonly
transfer List
transfer List ?: TransferListItem []
@@ -172,7 +172,7 @@
+Defined in src/utility-types.ts:81
Readonly
worker Id
worker Id : number
@@ -181,7 +181,7 @@
+Defined in src/utility-types.ts:69
+Defined in src/pools/pool.ts:85
Optional
Readonly
stolen Tasks
stolen Tasks ?: number
+Defined in src/pools/pool.ts:83
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:67
Readonly
type
type : "fixed" | "dynamic"
+Defined in src/pools/pool.ts:64
Optional
Readonly
utilization
utilization ?: number
@@ -154,12 +154,12 @@
+Defined in src/pools/pool.ts:71
Readonly
version
version : string
+Defined in src/pools/pool.ts:63
Optional
Readonly
wait Time
wait Time ?: {     average ?: number ;     maximum : number ;     median ?: number ;     minimum : number ; }
@@ -175,12 +175,12 @@
Readonly
minimum : number
+Defined in src/pools/pool.ts:91
Readonly
worker
worker : "thread" | "cluster"
+Defined in src/pools/pool.ts:65
Readonly
worker Nodes
worker Nodes : number
@@ -188,7 +188,7 @@
+Defined in src/pools/pool.ts:73
+Defined in src/pools/pool.ts:138
Optional
exit Handler
@@ -93,7 +93,7 @@
+Defined in src/pools/pool.ts:142
Optional
message Handler
@@ -101,7 +101,7 @@
+Defined in src/pools/pool.ts:134
Optional
online Handler
@@ -109,7 +109,7 @@
+Defined in src/pools/pool.ts:130
Optional
restart Worker On Error
restart Worker On Error ?: boolean
@@ -117,7 +117,7 @@
+Defined in src/pools/pool.ts:156
Optional
tasks Queue Options
@@ -125,7 +125,7 @@
+Defined in src/pools/pool.ts:172
Optional
worker Choice Strategy
worker Choice Strategy ?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -136,7 +136,7 @@
Copy
+Defined in src/pools/pool.ts:148
Optional
worker Choice Strategy Options
@@ -144,7 +144,7 @@
+Defined in src/pools/pool.ts:152
+Defined in src/utility-types.ts:153
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:156
+Defined in src/utility-types.ts:89
Optional
Readonly
timestamp
timestamp ?: number
@@ -82,7 +82,7 @@
+Defined in src/utility-types.ts:85
Optional
Readonly
transfer List
transfer List ?: TransferListItem []
@@ -90,7 +90,7 @@
+Defined in src/utility-types.ts:81
Readonly
worker Id
worker Id : number
@@ -98,7 +98,7 @@
+Defined in src/utility-types.ts:69
+Defined in src/utility-types.ts:14
+Defined in src/utility-types.ts:42
Readonly
timestamp
timestamp : number
@@ -70,7 +70,7 @@
+Defined in src/utility-types.ts:38
+Defined in src/pools/worker.ts:106
Optional
Readonly
max Queued
max Queued ?: 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:140
+Defined in src/pools/pool.ts:108
+Defined in src/pools/pool.ts:148
Optional
worker Choice Strategy Options
@@ -146,7 +146,7 @@
+Defined in src/pools/pool.ts:152
+Defined in src/pools/thread/fixed.ts:24
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:75
Optional
Readonly
run Time
@@ -81,7 +81,7 @@
Copy
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:85
Optional
Readonly
wait Time
@@ -92,7 +92,7 @@
Copy
+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.
Copy
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:104
+Defined in src/pools/worker.ts:143
Optional
task Functions
task Functions ?: string []
@@ -71,7 +71,7 @@
+Defined in src/pools/worker.ts:147
type
type : "thread" | "cluster"
@@ -79,7 +79,7 @@
+Defined in src/pools/worker.ts:135
+Defined in src/worker/worker-options.ts:56
Optional
max Inactive Time
max Inactive Time ?: number
@@ -93,7 +93,7 @@ when this timeout expires your tasks is interrupted before completion and remove
Copy
+Defined in src/worker/worker-options.ts:52
+Defined in src/pools/worker.ts:167
Throws
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
+