From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Date: Thu, 24 Aug 2023 10:38:35 +0000 (+0000)
Subject: chore: generate documentation
X-Git-Tag: v2.6.35~24^2
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=95c333666812f5db34b93c20d8851f2755d1c920;p=poolifier.git
chore: generate documentation
---
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 22404f94..ae49d8ab 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
@@ -189,7 +189,7 @@
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:113
Protected
Readonly
file Path
file Path : string
@@ -218,7 +218,7 @@
+Defined in src/pools/abstract-pool.ts:115
Protected
Optional
Readonly
max
max ?: number
@@ -226,7 +226,7 @@
+Defined in src/pools/abstract-pool.ts:91
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -234,7 +234,7 @@
+Defined in src/pools/abstract-pool.ts:114
Protected
Readonly
opts
@@ -242,7 +242,7 @@
+Defined in src/pools/abstract-pool.ts:116
Protected
promise Response Map
@@ -255,7 +255,7 @@
+Defined in src/pools/abstract-pool.ts:76
Private
Readonly
start Timestamp
start Timestamp : number
@@ -263,7 +263,7 @@
+Defined in src/pools/abstract-pool.ts:104
Private
started
started : boolean
@@ -271,7 +271,7 @@
+Defined in src/pools/abstract-pool.ts:100
Private
Readonly
starting
starting : boolean
@@ -279,7 +279,7 @@
+Defined in src/pools/abstract-pool.ts:96
Protected
worker Choice Strategy Context
@@ -287,7 +287,7 @@
+Defined in src/pools/abstract-pool.ts:82
Readonly
Internal
worker Nodes
@@ -296,7 +296,7 @@
+Defined in src/pools/abstract-pool.ts:63
Protected
full
@@ -322,7 +322,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:682
+Defined in src/pools/abstract-pool.ts:354
Protected
max Size
@@ -345,7 +345,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:555
Protected
min Size
@@ -356,7 +356,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:548
Private
ready
@@ -367,7 +367,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:500
Protected
Abstract
type
@@ -379,7 +379,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:538
+Defined in src/pools/abstract-pool.ts:517
Protected
Abstract
worker
@@ -402,7 +402,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:543
Protected
after Task Execution Hook
@@ -451,7 +451,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:879
Protected
after Worker Node Setup
@@ -471,7 +471,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1151
Protected
before Task Execution Hook
@@ -496,7 +496,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:849
Private
build Tasks Queue Options
@@ -509,7 +509,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:665
Private
check And Emit Dynamic Worker Creation Events
@@ -517,7 +517,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1376
Private
check And Emit Task Execution Events
@@ -525,7 +525,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1364
Private
check And Emit Task Queuing Events
@@ -533,7 +533,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1370
Protected
check Dynamic Pool Size
@@ -548,7 +548,7 @@ Can be overridden.
max : number
Returns void
+Defined in src/pools/abstract-pool.ts:185
Private
check File Path
@@ -561,7 +561,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:565
Private
check Number Of Workers
@@ -595,7 +595,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:167
Private
check Pool Options
@@ -608,7 +608,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:211
Private
check Valid Tasks Queue Options
@@ -621,7 +621,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:293
Private
check Valid Worker Choice Strategy
@@ -634,7 +634,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
@@ -647,7 +647,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:249
Private
choose Worker Node
@@ -660,7 +660,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1004
Protected
create And Setup Dynamic Worker Node
@@ -672,7 +672,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1094
Protected
create And Setup Worker Node
@@ -684,7 +684,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1050
Protected
Abstract
create Worker
@@ -696,7 +696,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1043
Private
dequeue Task
@@ -709,7 +709,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1467
+Defined in src/pools/abstract-pool.ts:794
Protected
Abstract
destroy Worker Node
@@ -740,7 +740,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:825
+Defined in src/pools/abstract-pool.ts:636
Private
enqueue Task
@@ -780,7 +780,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1461
+Defined in src/pools/abstract-pool.ts:732
Private
execute Task
@@ -835,7 +835,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1455
Protected
flush Tasks Queue
@@ -848,7 +848,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1475
Private
flush Tasks Queues
@@ -856,7 +856,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1485
Protected
get Worker Info
@@ -876,7 +876,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1390
Private
get Worker Node Key By Worker
@@ -896,7 +896,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:584
Private
get Worker Node Key By Worker Id
@@ -916,7 +916,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:596
Private
handle Task Execution Response
@@ -929,7 +929,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1336
Private
handle Worker Ready Response
@@ -942,7 +942,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1322
Private
has Back Pressure
@@ -950,7 +950,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1440
has Worker Node Back Pressure
+Defined in src/pools/abstract-pool.ts:1433
Protected
internal Busy
@@ -983,7 +983,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:698
Protected
Abstract
is Main
@@ -994,7 +994,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:840
+Defined in src/pools/abstract-pool.ts:719
Private
redistribute Queued Tasks
@@ -1020,7 +1020,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1191
Protected
Abstract
register Worker Message Listener
@@ -1060,7 +1060,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1138
Private
remove Worker Node
@@ -1079,7 +1079,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1424
Protected
send Kill Message To Worker
@@ -1094,7 +1094,7 @@ Can be overridden.
workerId : number
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:804
Protected
Abstract
send Startup Message To Worker
@@ -1113,7 +1113,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1171
Private
send Statistics Message To Worker
@@ -1132,7 +1132,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1178
Protected
Abstract
send To Worker
@@ -1161,7 +1161,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1032
Private
set Tasks Queue Max Size
@@ -1174,7 +1174,7 @@ Can be overridden.
size : number
Returns void
+Defined in src/pools/abstract-pool.ts:659
+Defined in src/pools/abstract-pool.ts:648
+Defined in src/pools/abstract-pool.ts:603
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:622
Protected
setup Hook
@@ -1251,7 +1251,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:833
Private
shall Create Dynamic Worker
@@ -1263,7 +1263,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1021
Private
shall Update Task Function Worker Usage
@@ -1283,7 +1283,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:912
Private
start Pool
@@ -1291,7 +1291,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:341
Private
task Stealing On Empty Queue
@@ -1304,7 +1304,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1229
Private
tasks Queue Size
@@ -1317,7 +1317,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1471
Private
tasks Stealing On Back Pressure
@@ -1330,7 +1330,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1264
Private
update Elu Worker Usage
@@ -1345,7 +1345,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:965
Private
update Run Time Worker Usage
@@ -1360,7 +1360,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:939
Private
update Task Statistics Worker Usage
@@ -1375,7 +1375,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:921
Private
update Wait Time Worker Usage
@@ -1390,7 +1390,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:951
Protected
worker Listener
@@ -1417,7 +1417,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1302
+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:568
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:409
Private
check Message Worker Id
+Defined in src/worker/abstract-worker.ts:375
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:592
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:298
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:108
Private
check Worker Options
@@ -390,7 +390,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:98
emit Destroy
@@ -419,7 +419,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:577
Protected
get Main Worker
@@ -431,7 +431,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:423
+Defined in src/worker/abstract-worker.ts:559
Protected
handle Error
@@ -473,7 +473,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:455
Protected
handle Kill Message
@@ -492,7 +492,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:341
Protected
Abstract
handle Ready Message
@@ -511,7 +511,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:312
+Defined in src/worker/abstract-worker.ts:167
list Task Functions
@@ -545,7 +545,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:245
Protected
message Listener
@@ -564,7 +564,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:319
+Defined in src/worker/abstract-worker.ts:221
+Defined in src/worker/abstract-worker.ts:465
Protected
run Async
@@ -635,7 +635,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:517
run In Async Scope
@@ -714,7 +714,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:480
Protected
send Task Functions List To Main Worker
@@ -725,7 +725,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:442
Protected
Abstract
send To Main Worker
@@ -744,7 +744,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:435
+Defined in src/worker/abstract-worker.ts:275
Private
start Check Active
@@ -781,7 +781,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:388
Private
stop Check Active
@@ -792,7 +792,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:399
trigger Async Id
@@ -811,7 +811,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:598
Static
bind
diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html
index 3480e5da..0f565896 100644
--- a/docs/classes/CircularArray.html
+++ b/docs/classes/CircularArray.html
@@ -14,7 +14,7 @@
-Class CircularArray<T>
+Class CircularArray<T>Internal
+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. If start is omitted, 0
is used.
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 ad765eeb..431d7797 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:423
+Defined in src/worker/abstract-worker.ts:455
Protected
handle Kill Message
+Defined in src/worker/abstract-worker.ts:341
Protected
handle Ready Message
+Defined in src/worker/cluster-worker.ts:45
+Defined in src/worker/abstract-worker.ts:167
+Defined in src/worker/abstract-worker.ts:245
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:319
+Defined in src/worker/abstract-worker.ts:221
+Defined in src/worker/abstract-worker.ts:465
+Defined in src/worker/abstract-worker.ts:517
+Defined in src/worker/abstract-worker.ts:480
Protected
send Task Functions List To Main Worker
+Defined in src/worker/abstract-worker.ts:442
Protected
send To Main Worker
+Defined in src/worker/cluster-worker.ts:70
+Defined in src/worker/abstract-worker.ts:275
trigger Async Id
diff --git a/docs/classes/Deque.html b/docs/classes/Deque.html
index 4e315864..2e70f741 100644
--- a/docs/classes/Deque.html
+++ b/docs/classes/Deque.html
@@ -14,7 +14,7 @@
-Class Deque<T>
+Class Deque<T>Internal
+Defined in src/deque.ts:29
size
size : number
@@ -100,12 +100,12 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:27
+Defined in src/deque.ts:25
+Defined in src/deque.ts:167
clear
@@ -146,7 +146,7 @@ Implemented with a doubly linked list.
Returns void
+Defined in src/deque.ts:128
Private
increment Size
@@ -154,7 +154,7 @@ Implemented with a doubly linked list.
Returns number
+Defined in src/deque.ts:191
peek First
@@ -166,7 +166,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:113
peek Last
@@ -178,7 +178,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:121
pop
@@ -190,7 +190,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:74
push
@@ -210,7 +210,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:41
shift
@@ -222,7 +222,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:94
unshift
@@ -242,7 +242,7 @@ Implemented with a doubly linked list.
+Defined in src/deque.ts:58
+Defined in src/worker/abstract-worker.ts:465
+Defined in src/worker/abstract-worker.ts:517
+Defined in src/worker/abstract-worker.ts:480
Protected
send Task Functions List To Main Worker
+Defined in src/worker/abstract-worker.ts:442
Protected
send To Main Worker
+Defined in src/worker/thread-worker.ts:91
+Defined in src/worker/abstract-worker.ts:275
trigger Async Id
diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html
index e5e0e43e..f72f5bc9 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
opts
@@ -126,12 +126,12 @@
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:52
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/cluster/fixed.ts:22
Optional
tasks Queue Options
@@ -144,7 +144,7 @@
+Defined in src/pools/pool.ts:171
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:147
Optional
worker Choice Strategy Options
@@ -164,7 +164,7 @@
+Defined in src/pools/pool.ts:151
+Defined in src/pools/pool.ts:226
Readonly
has Worker Node Back Pressure
has Worker Node Back Pressure : ( ( workerNodeKey ) => boolean )
@@ -190,7 +190,7 @@
+Defined in src/pools/pool.ts:203
Readonly
info
@@ -198,7 +198,7 @@
+Defined in src/pools/pool.ts:189
Readonly
list Task Functions
list Task Functions : ( ( ) => string [] )
@@ -215,7 +215,7 @@
+Defined in src/pools/pool.ts:240
Readonly
set Tasks Queue Options
set Tasks Queue Options : ( ( tasksQueueOptions ) => void )
@@ -239,7 +239,7 @@
Returns void
+Defined in src/pools/pool.ts:274
Readonly
set Worker Choice Strategy
set Worker Choice Strategy : ( ( workerChoiceStrategy , workerChoiceStrategyOptions ? ) => void )
@@ -268,7 +268,7 @@
Returns void
+Defined in src/pools/pool.ts:247
Readonly
set Worker Choice Strategy Options
set Worker Choice Strategy Options : ( ( workerChoiceStrategyOptions ) => void )
@@ -292,7 +292,7 @@
Returns void
+Defined in src/pools/pool.ts:256
Readonly
Internal
worker Nodes
@@ -300,7 +300,7 @@
+Defined in src/pools/pool.ts:195
+Defined in src/pools/worker.ts:195
Optional
Readonly
thread Id
thread Id ?: number
+Defined in src/pools/worker.ts:178
+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:264
Readonly
enqueue Task
enqueue Task : ( ( task ) => number )
@@ -138,7 +138,7 @@
+Defined in src/pools/worker.ts:251
Readonly
get Task Function Worker Usage
get Task Function Worker Usage : ( ( name ) => undefined | WorkerUsage )
@@ -163,7 +163,7 @@
+Defined in src/pools/worker.ts:295
Readonly
has Back Pressure
has Back Pressure : ( ( ) => boolean )
@@ -180,7 +180,7 @@
+Defined in src/pools/worker.ts:280
Readonly
info
@@ -188,7 +188,7 @@
+Defined in src/pools/worker.ts:213
Optional
Readonly
message Channel
message Channel ?: MessageChannel
@@ -196,7 +196,7 @@
+Defined in src/pools/worker.ts:217
Optional
on Back Pressure
on Back Pressure ?: ( ( workerId ) => void )
@@ -220,7 +220,7 @@
Returns void
+Defined in src/pools/worker.ts:232
Optional
on Empty Queue
on Empty Queue ?: ( ( workerId ) => void )
@@ -244,7 +244,7 @@
Returns void
+Defined in src/pools/worker.ts:238
Readonly
pop Task
pop Task : ( ( ) => undefined | Task < Data > )
@@ -261,7 +261,7 @@
+Defined in src/pools/worker.ts:270
Readonly
reset Usage
reset Usage : ( ( ) => void )
@@ -277,7 +277,7 @@
Returns void
+Defined in src/pools/worker.ts:284
tasks Queue Back Pressure Size
tasks Queue Back Pressure Size : number
@@ -286,7 +286,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:226
Readonly
tasks Queue Size
tasks Queue Size : ( ( ) => number )
@@ -303,7 +303,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:244
Readonly
unshift Task
unshift Task : ( ( task ) => number )
@@ -328,7 +328,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:258
usage
@@ -336,7 +336,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:221
Readonly
worker
worker : Worker
@@ -344,7 +344,7 @@ This is the number of tasks that can be enqueued before the worker node has back
+Defined in src/pools/worker.ts:209
+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: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:67
Readonly
type
type : "fixed" | "dynamic"
+Defined in src/pools/pool.ts:64
Optional
Readonly
utilization
utilization ?: number
@@ -148,12 +148,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 ; }
@@ -169,12 +169,12 @@
Readonly
minimum : number
+Defined in src/pools/pool.ts:90
Readonly
worker
worker : "thread" | "cluster"
+Defined in src/pools/pool.ts:65
Readonly
worker Nodes
worker Nodes : number
@@ -182,7 +182,7 @@
+Defined in src/pools/pool.ts:73
+Defined in src/pools/pool.ts:137
Optional
exit Handler
@@ -91,7 +91,7 @@
+Defined in src/pools/pool.ts:141
Optional
message Handler
@@ -99,7 +99,7 @@
+Defined in src/pools/pool.ts:133
Optional
online Handler
@@ -107,7 +107,7 @@
+Defined in src/pools/pool.ts:129
Optional
restart Worker On Error
restart Worker On Error ?: boolean
@@ -115,7 +115,7 @@
+Defined in src/pools/pool.ts:155
Optional
tasks Queue Options
@@ -123,7 +123,7 @@
+Defined in src/pools/pool.ts:171
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:147
Optional
worker Choice Strategy Options
@@ -141,7 +141,7 @@
+Defined in src/pools/pool.ts:151
+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:102
Optional
Readonly
max Queued
max Queued ?: number
@@ -71,7 +71,7 @@
+Defined in src/pools/worker.ts:98
Readonly
queued
queued : number
@@ -79,7 +79,7 @@
+Defined in src/pools/worker.ts:94
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:140
+Defined in src/pools/pool.ts:107
+Defined in src/pools/pool.ts:147
Optional
worker Choice Strategy Options
@@ -143,7 +143,7 @@
+Defined in src/pools/pool.ts:151
+Defined in src/pools/thread/fixed.ts:24
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:79
Optional
Readonly
run Time
@@ -78,7 +78,7 @@
Default Value { median: false }
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:85
Optional
Readonly
wait Time
@@ -88,7 +88,7 @@
Default Value { median: false }
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:91
Optional
Readonly
weights
weights ?: Record < number , number >
@@ -99,7 +99,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:104
+Defined in src/pools/worker.ts:139
Optional
task Functions
task Functions ?: string []
@@ -71,7 +71,7 @@
+Defined in src/pools/worker.ts:143
type
type : "thread" | "cluster"
@@ -79,7 +79,7 @@
+Defined in src/pools/worker.ts:131
+Defined in src/worker/worker-options.ts:56
Optional
max Inactive Time
max Inactive Time ?: number
@@ -90,7 +90,7 @@ when this timeout expires your tasks is interrupted before completion and remove
Default Value 60000
+Defined in src/worker/worker-options.ts:52
+Defined in src/pools/worker.ts:163
Array with a maximum length and shifting items when full.