From: Documentation Bot
Date: Mon, 18 Sep 2023 12:51:55 +0000 (+0000)
Subject: docs: generate documentation
X-Git-Tag: v2.7.0~7^2
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=3eed67feea0f527e3ee31a6ebb1063883eec3855;p=poolifier.git
docs: generate documentation
---
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index de299a1e..e382e9e1 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:59
@@ -195,7 +195,7 @@
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:114
Protected
Readonly
file Path
file Path : string
@@ -224,7 +224,7 @@
+Defined in src/pools/abstract-pool.ts:116
Protected
Optional
Readonly
max
max ?: number
@@ -232,7 +232,7 @@
+Defined in src/pools/abstract-pool.ts:92
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -240,7 +240,7 @@
+Defined in src/pools/abstract-pool.ts:115
Protected
Readonly
opts
@@ -248,7 +248,7 @@
+Defined in src/pools/abstract-pool.ts:117
Protected
promise Response Map
@@ -261,7 +261,7 @@
+Defined in src/pools/abstract-pool.ts:77
Private
Readonly
start Timestamp
start Timestamp : number
@@ -269,7 +269,7 @@
+Defined in src/pools/abstract-pool.ts:105
Private
started
started : boolean
@@ -277,7 +277,7 @@
+Defined in src/pools/abstract-pool.ts:97
Private
starting
starting : boolean
@@ -285,7 +285,7 @@
+Defined in src/pools/abstract-pool.ts:101
Protected
worker Choice Strategy Context
@@ -293,7 +293,7 @@
+Defined in src/pools/abstract-pool.ts:83
Readonly
Internal
worker Nodes
@@ -302,7 +302,7 @@
+Defined in src/pools/abstract-pool.ts:65
Protected
full
@@ -328,7 +328,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:722
+Defined in src/pools/abstract-pool.ts:342
Protected
max Size
@@ -351,7 +351,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:555
Protected
min Size
@@ -362,7 +362,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:548
Private
ready
@@ -373,7 +373,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:500
Protected
Abstract
type
@@ -385,7 +385,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:538
+Defined in src/pools/abstract-pool.ts:517
Protected
Abstract
worker
@@ -408,7 +408,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:543
Protected
after Task Execution Hook
@@ -457,7 +457,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:935
Protected
after Worker Node Setup
@@ -477,7 +477,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1209
Protected
before Task Execution Hook
@@ -502,7 +502,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:905
Private
build Tasks Queue Options
@@ -515,7 +515,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:671
Private
check And Emit Dynamic Worker Creation Events
@@ -523,7 +523,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1444
Private
check And Emit Task Execution Events
@@ -531,7 +531,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1432
Private
check And Emit Task Queuing Events
@@ -539,7 +539,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1438
Protected
check Dynamic Pool Size
@@ -554,7 +554,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:187
Private
check File Path
@@ -567,7 +567,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:156
Private
check Message Worker Id
+Defined in src/pools/abstract-pool.ts:565
Private
check Number Of Workers
@@ -601,7 +601,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:169
Private
check Pool Options
@@ -614,7 +614,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:213
Private
check Valid Tasks Queue Options
@@ -627,7 +627,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:304
Private
check Valid Worker Choice Strategy
@@ -640,7 +640,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:244
Private
check Valid Worker Choice Strategy Options
@@ -653,7 +653,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:257
Private
choose Worker Node
@@ -666,7 +666,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1062
Protected
create And Setup Dynamic Worker Node
@@ -678,7 +678,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1152
Protected
create And Setup Worker Node
@@ -690,7 +690,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1108
Protected
Abstract
create Worker
@@ -702,7 +702,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1101
Private
dequeue Task
@@ -715,7 +715,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1534
+Defined in src/pools/abstract-pool.ts:850
Protected
Abstract
destroy Worker Node
@@ -746,7 +746,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:881
+Defined in src/pools/abstract-pool.ts:636
Private
enqueue Task
@@ -786,7 +786,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1528
+Defined in src/pools/abstract-pool.ts:779
Private
execute Task
@@ -841,7 +841,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1522
Protected
flush Tasks Queue
@@ -854,7 +854,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1542
Private
flush Tasks Queues
@@ -862,7 +862,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1552
Protected
get Worker Info
@@ -882,7 +882,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1458
Private
get Worker Node Key By Worker
@@ -902,7 +902,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:584
Private
get Worker Node Key By Worker Id
@@ -922,7 +922,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:596
Private
handle Task Execution Response
@@ -935,7 +935,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1404
Private
handle Worker Ready Response
@@ -948,7 +948,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1390
Private
has Back Pressure
@@ -956,7 +956,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1507
has Worker Node Back Pressure
+Defined in src/pools/abstract-pool.ts:1500
Protected
internal Busy
@@ -989,7 +989,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:738
Protected
Abstract
is Main
@@ -1000,7 +1000,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:896
+Defined in src/pools/abstract-pool.ts:758
Private
redistribute Queued Tasks
@@ -1026,7 +1026,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1253
Protected
Abstract
register Worker Message Listener
@@ -1066,7 +1066,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1196
Private
remove Worker Node
@@ -1085,7 +1085,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1491
Protected
send Kill Message To Worker
@@ -1100,7 +1100,7 @@ Can be overridden.
workerId : number
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:860
Protected
Abstract
send Startup Message To Worker
@@ -1119,7 +1119,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1233
Private
send Statistics Message To Worker
@@ -1138,7 +1138,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1240
Protected
Abstract
send To Worker
@@ -1167,7 +1167,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1090
Private
set Task Stealing
@@ -1175,7 +1175,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:691
+Defined in src/pools/abstract-pool.ts:650
Private
set Tasks Queue Size
@@ -1208,7 +1208,7 @@ Can be overridden.
size : number
Returns void
+Defined in src/pools/abstract-pool.ts:685
Private
set Tasks Stealing On Back Pressure
@@ -1216,7 +1216,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:704
+Defined in src/pools/abstract-pool.ts:603
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:622
Protected
setup Hook
@@ -1273,7 +1273,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:889
Private
shall Create Dynamic Worker
@@ -1285,7 +1285,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1079
Private
shall Execute Task
@@ -1298,7 +1298,7 @@ Can be overridden.
workerNodeKey : number
Returns boolean
+Defined in src/pools/abstract-pool.ts:770
Private
shall Update Task Function Worker Usage
@@ -1318,7 +1318,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:968
+Defined in src/pools/abstract-pool.ts:834
Private
task Stealing On Empty Queue
@@ -1343,7 +1343,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1297
Private
tasks Queue Size
@@ -1356,7 +1356,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1538
Private
tasks Stealing On Back Pressure
@@ -1369,7 +1369,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1329
Private
unset Task Stealing
@@ -1377,7 +1377,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:698
Private
unset Tasks Stealing On Back Pressure
@@ -1385,7 +1385,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:711
Private
update Elu Worker Usage
@@ -1400,7 +1400,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1022
Private
update Run Time Worker Usage
@@ -1415,7 +1415,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:995
Private
update Task Statistics Worker Usage
@@ -1430,7 +1430,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:977
Private
update Task Stolen Statistics Worker Usage
@@ -1445,7 +1445,7 @@ Can be overridden.
taskName : string
Returns void
+Defined in src/pools/abstract-pool.ts:1278
Private
update Wait Time Worker Usage
@@ -1460,7 +1460,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:1009
Protected
worker Listener
@@ -1487,7 +1487,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1372
+Defined in src/worker/abstract-worker.ts:85
Protected
last Task Timestamp
last Task Timestamp : number
@@ -188,7 +188,7 @@
+Defined in src/worker/abstract-worker.ts:65
Private
Readonly
main Worker
main Worker : MainWorker
@@ -196,7 +196,7 @@
+Defined in src/worker/abstract-worker.ts:86
Protected
opts
@@ -204,7 +204,7 @@
+Defined in src/worker/abstract-worker.ts:88
Protected
statistics
@@ -212,7 +212,7 @@
+Defined in src/worker/abstract-worker.ts:69
Protected
task Functions
@@ -220,7 +220,7 @@
+Defined in src/worker/abstract-worker.ts:61
async Id
@@ -278,7 +278,7 @@ If a task function with the same name already exists, it is replaced.
Optional
name : string
+Defined in src/worker/abstract-worker.ts:601
bind
@@ -316,7 +316,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:446
Private
check Message Worker Id
+Defined in src/worker/abstract-worker.ts:412
Private
check Statistics
@@ -345,7 +345,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:625
Private
check Task Function Name
@@ -358,7 +358,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:335
Private
check Task Functions
@@ -377,7 +377,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:159
Private
check Valid Task Function Entry
@@ -392,7 +392,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:133
Private
check Worker Options
@@ -405,7 +405,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
@@ -434,7 +434,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:610
+Defined in src/worker/abstract-worker.ts:461
Protected
handle Error
@@ -468,7 +468,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:493
Protected
handle Kill Message
@@ -487,7 +487,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:378
Protected
Abstract
handle Ready Message
@@ -506,7 +506,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:349
+Defined in src/worker/abstract-worker.ts:204
list Task Functions
@@ -540,7 +540,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:282
Protected
message Listener
@@ -559,7 +559,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:356
+Defined in src/worker/abstract-worker.ts:258
+Defined in src/worker/abstract-worker.ts:503
Protected
run Async
@@ -630,7 +630,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:567
run In Async Scope
@@ -709,7 +709,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:531
Protected
send Task Functions List To Main Worker
@@ -720,7 +720,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:480
Protected
Abstract
send To Main Worker
@@ -739,7 +739,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:473
+Defined in src/worker/abstract-worker.ts:312
Private
start Check Active
@@ -776,7 +776,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:425
Private
stop Check Active
@@ -787,7 +787,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:436
trigger Async Id
@@ -806,7 +806,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:631
Static
bind
diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html
index 80b6fc11..3497410a 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
@@ -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: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
copy Within
@@ -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
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:32
values
diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html
index 2e6e42dc..35af35a0 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
@@ -127,7 +127,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
@@ -147,7 +147,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
@@ -156,7 +156,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:65
Protected
opts
@@ -165,7 +165,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:88
Protected
statistics
@@ -174,7 +174,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:69
Protected
task Functions
@@ -183,7 +183,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:61
Accessors
@@ -197,7 +197,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:461
+Defined in src/worker/abstract-worker.ts:493
Protected
handle Kill Message
+Defined in src/worker/abstract-worker.ts:378
Protected
handle Ready Message
+Defined in src/worker/cluster-worker.ts:45
+Defined in src/worker/abstract-worker.ts:204
+Defined in src/worker/abstract-worker.ts:282
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:356
+Defined in src/worker/abstract-worker.ts:258
+Defined in src/worker/abstract-worker.ts:503
+Defined in src/worker/abstract-worker.ts:567
+Defined in src/worker/abstract-worker.ts:531
Protected
send Task Functions List To Main Worker
+Defined in src/worker/abstract-worker.ts:480
Protected
send To Main Worker
+Defined in src/worker/cluster-worker.ts:70
+Defined in src/worker/abstract-worker.ts:312
trigger Async Id
diff --git a/docs/classes/Deque.html b/docs/classes/Deque.html
index 11541e8a..2241e0f1 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
@@ -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
+Defined in src/worker/abstract-worker.ts:312
trigger Async Id
diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html
index 0ee5e696..46f0f65c 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
@@ -126,12 +126,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
@@ -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
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
@@ -218,7 +218,7 @@
Returns void
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:213
set Worker Choice Strategy
@@ -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
+Defined in src/pools/pool.ts:153
Optional
exit Handler
@@ -105,7 +105,7 @@
+Defined in src/pools/pool.ts:159
Optional
message Handler
@@ -116,7 +116,7 @@
+Defined in src/pools/pool.ts:147
Optional
online Handler
@@ -127,7 +127,7 @@
+Defined in src/pools/pool.ts:141
Optional
restart Worker On Error
restart Worker On Error ?: boolean
@@ -136,7 +136,7 @@
+Defined in src/pools/pool.ts:179
+Defined in src/pools/cluster/fixed.ts:22
Optional
start Workers
start Workers ?: boolean
@@ -158,7 +158,7 @@
+Defined in src/pools/pool.ts:165
Optional
tasks Queue Options
@@ -167,7 +167,7 @@
+Defined in src/pools/pool.ts:195
Optional
worker Choice Strategy
worker Choice Strategy ?: "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:171
Optional
worker Choice Strategy Options
@@ -188,7 +188,7 @@
+Defined in src/pools/pool.ts:175
+Defined in src/pools/pool.ts:250
Readonly
has Worker Node Back Pressure
has Worker Node Back Pressure : ( ( workerNodeKey ) => boolean )
@@ -191,7 +191,7 @@
+Defined in src/pools/pool.ts:227
Readonly
info
@@ -199,7 +199,7 @@
+Defined in src/pools/pool.ts:213
Readonly
list Task Functions
list Task Functions : ( ( ) => string [] )
@@ -216,7 +216,7 @@
+Defined in src/pools/pool.ts:268
Readonly
set Tasks Queue Options
set Tasks Queue Options : ( ( tasksQueueOptions ) => void )
@@ -240,7 +240,7 @@
Returns void
+Defined in src/pools/pool.ts:302
Readonly
set Worker Choice Strategy
set Worker Choice Strategy : ( ( workerChoiceStrategy , workerChoiceStrategyOptions ? ) => void )
@@ -269,7 +269,7 @@
Returns void
+Defined in src/pools/pool.ts:275
Readonly
set Worker Choice Strategy Options
set Worker Choice Strategy Options : ( ( workerChoiceStrategyOptions ) => void )
@@ -293,7 +293,7 @@
Returns void
+Defined in src/pools/pool.ts:284
Readonly
start
start : ( ( ) => void )
@@ -309,7 +309,7 @@
Returns void
+Defined in src/pools/pool.ts:258
Readonly
Internal
worker Nodes
@@ -317,7 +317,7 @@
+Defined in src/pools/pool.ts:219
+Defined in src/pools/worker.ts:208
Optional
Readonly
thread Id
thread Id ?: number
+Defined in src/pools/worker.ts:191
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:182
Readonly
set Options
set Options : ( ( opts ) => void )
@@ -125,7 +125,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
@@ -133,7 +133,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
@@ -141,7 +141,7 @@ If the worker node is not eligible, undefined
is returned.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:176
Readonly
update
update : ( ( workerNodeKey ) => boolean )
@@ -163,7 +163,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:286
Readonly
enqueue Task
enqueue Task : ( ( task ) => number )
@@ -139,7 +139,7 @@
+Defined in src/pools/worker.ts:273
Readonly
get Task Function Worker Usage
get Task Function Worker Usage : ( ( name ) => undefined | WorkerUsage )
@@ -164,7 +164,7 @@
+Defined in src/pools/worker.ts:317
Readonly
has Back Pressure
has Back Pressure : ( ( ) => boolean )
@@ -181,7 +181,7 @@
+Defined in src/pools/worker.ts:302
Readonly
info
@@ -189,7 +189,7 @@
+Defined in src/pools/worker.ts:234
Optional
Readonly
message Channel
message Channel ?: MessageChannel
@@ -197,7 +197,7 @@
+Defined in src/pools/worker.ts:247
Optional
on Back Pressure
@@ -205,7 +205,7 @@
+Defined in src/pools/worker.ts:256
Optional
on Empty Queue
@@ -213,7 +213,7 @@
+Defined in src/pools/worker.ts:260
Readonly
pop Task
pop Task : ( ( ) => undefined | Task < Data > )
@@ -230,7 +230,7 @@
+Defined in src/pools/worker.ts:292
Readonly
reset Usage
reset Usage : ( ( ) => void )
@@ -246,7 +246,7 @@
Returns void
+Defined in src/pools/worker.ts:306
Optional
strategy Data
@@ -255,7 +255,7 @@ This is used to store data that is specific to the worker choice strategy.
+Defined in src/pools/worker.ts:243
tasks Queue Back Pressure Size
tasks Queue Back Pressure Size : number
@@ -264,7 +264,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:252
Readonly
tasks Queue Size
tasks Queue Size : ( ( ) => number )
@@ -281,7 +281,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:266
Readonly
unshift Task
unshift Task : ( ( task ) => number )
@@ -306,7 +306,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:280
Readonly
usage
@@ -314,7 +314,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:238
Readonly
worker
worker : Worker
@@ -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:230
+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:138
Optional
Readonly
ready
ready ?: boolean
@@ -113,7 +113,7 @@
+Defined in src/utility-types.ts:130
Optional
Readonly
statistics
@@ -121,7 +121,7 @@
+Defined in src/utility-types.ts:126
Optional
Readonly
task Error
@@ -129,7 +129,7 @@
+Defined in src/utility-types.ts:114
Optional
Readonly
task Functions
task Functions ?: string []
@@ -137,7 +137,7 @@
+Defined in src/utility-types.ts:122
Optional
Readonly
task Id
task Id ?: string
@@ -146,7 +146,7 @@
+Defined in src/utility-types.ts:95
Optional
Readonly
task Performance
@@ -154,7 +154,7 @@
+Defined in src/utility-types.ts:118
Optional
Readonly
timestamp
timestamp ?: number
@@ -163,7 +163,7 @@
+Defined in src/utility-types.ts:91
Optional
Readonly
transfer List
transfer List ?: TransferListItem []
@@ -172,7 +172,7 @@
+Defined in src/utility-types.ts:87
Readonly
worker Id
worker Id : number
@@ -181,7 +181,7 @@
+Defined in src/utility-types.ts:75
+Defined in src/pools/pool.ts:86
Readonly
started
started : boolean
+Defined in src/pools/pool.ts:66
Optional
Readonly
stolen Tasks
stolen Tasks ?: number
+Defined in src/pools/pool.ts:84
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:68
Readonly
type
type : "fixed" | "dynamic"
+Defined in src/pools/pool.ts:64
Optional
Readonly
utilization
utilization ?: number
@@ -160,12 +160,12 @@
+Defined in src/pools/pool.ts:72
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 ; }
@@ -181,12 +181,12 @@
Readonly
minimum : number
+Defined in src/pools/pool.ts:92
Readonly
worker
worker : "thread" | "cluster"
+Defined in src/pools/pool.ts:65
Readonly
worker Nodes
worker Nodes : number
@@ -194,7 +194,7 @@
+Defined in src/pools/pool.ts:74
+Defined in src/pools/pool.ts:153
Optional
exit Handler
@@ -98,7 +98,7 @@
Default Value () => {}
+Defined in src/pools/pool.ts:159
Optional
message Handler
@@ -108,7 +108,7 @@
Default Value () => {}
+Defined in src/pools/pool.ts:147
Optional
online Handler
@@ -118,7 +118,7 @@
Default Value () => {}
+Defined in src/pools/pool.ts:141
Optional
restart Worker On Error
restart Worker On Error ?: boolean
@@ -126,7 +126,7 @@
+Defined in src/pools/pool.ts:179
Optional
start Workers
start Workers ?: boolean
@@ -137,7 +137,7 @@
Copy
+Defined in src/pools/pool.ts:165
Optional
tasks Queue Options
@@ -145,7 +145,7 @@
+Defined in src/pools/pool.ts:195
Optional
worker Choice Strategy
worker Choice Strategy ?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
@@ -156,7 +156,7 @@
Copy
+Defined in src/pools/pool.ts:171
Optional
worker Choice Strategy Options
@@ -164,7 +164,7 @@
+Defined in src/pools/pool.ts:175
+Defined in src/utility-types.ts:159
+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
transfer List
transfer List ?: TransferListItem []
@@ -90,7 +90,7 @@
+Defined in src/utility-types.ts:87
Readonly
worker Id
worker Id : number
@@ -98,7 +98,7 @@
+Defined in src/utility-types.ts:75
+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:121
Optional
Readonly
tasks Stealing On Back Pressure
tasks Stealing On Back Pressure ?: boolean
@@ -82,7 +82,7 @@
Copy
+Defined in src/pools/pool.ts:127
+Defined in src/pools/pool.ts:153
Optional
exit Handler
@@ -94,7 +94,7 @@
+Defined in src/pools/pool.ts:159
Optional
message Handler
@@ -105,7 +105,7 @@
+Defined in src/pools/pool.ts:147
Optional
online Handler
@@ -116,7 +116,7 @@
+Defined in src/pools/pool.ts:141
Optional
restart Worker On Error
restart Worker On Error ?: boolean
@@ -125,7 +125,7 @@
+Defined in src/pools/pool.ts:179
Optional
start Workers
start Workers ?: boolean
@@ -137,7 +137,7 @@
+Defined in src/pools/pool.ts:165
Optional
tasks Queue Options
@@ -146,7 +146,7 @@
+Defined in src/pools/pool.ts:195
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:171
Optional
worker Choice Strategy Options
@@ -167,7 +167,7 @@
+Defined in src/pools/pool.ts:175
+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
Readonly
type
type : "thread" | "cluster"
@@ -79,7 +79,7 @@
+Defined in src/pools/worker.ts:135
+Defined in src/worker/worker-options.ts:58
Optional
max Inactive Time
max Inactive Time ?: number
@@ -95,7 +95,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/utility-types.ts:58
+Defined in src/pools/worker.ts:159
Readonly
wait Time
@@ -70,7 +70,7 @@
+Defined in src/pools/worker.ts:167