From: Documentation Bot
Date: Tue, 26 Sep 2023 08:59:16 +0000 (+0000)
Subject: docs: generate documentation
X-Git-Tag: v2.7.5~39
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=aab0aa502b6d1ca1e2b480460d9cf5f34707c34c;p=poolifier.git
docs: generate documentation
---
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 57019215..13d1951e 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:64
@@ -202,7 +202,7 @@
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:126
Protected
Readonly
file Path
file Path : string
@@ -232,7 +232,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:128
Protected
Optional
Readonly
max
max ?: number
@@ -240,7 +240,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:97
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -248,7 +248,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -256,7 +256,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:129
Protected
promise Response Map
@@ -269,7 +269,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:82
Private
Readonly
start Timestamp
start Timestamp : number
@@ -277,7 +277,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:117
Private
started
started : boolean
@@ -285,7 +285,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:109
Private
starting
starting : boolean
@@ -293,7 +293,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:113
Private
Readonly
task Functions
@@ -305,7 +305,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:104
Protected
worker Choice Strategy Context
@@ -313,7 +313,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:88
Readonly
Internal
worker Nodes
@@ -322,7 +322,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:70
Accessors
@@ -336,7 +336,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
+Defined in src/pools/abstract-pool.ts:660
Protected
full
@@ -348,7 +348,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
+Defined in src/pools/abstract-pool.ts:651
info
@@ -360,7 +360,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:271
Protected
max Size
@@ -371,7 +371,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns number
+Defined in src/pools/abstract-pool.ts:484
Protected
min Size
@@ -382,7 +382,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns number
+Defined in src/pools/abstract-pool.ts:477
Private
ready
@@ -393,7 +393,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
+Defined in src/pools/abstract-pool.ts:429
Protected
Abstract
type
@@ -405,7 +405,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:467
Private
utilization
@@ -417,7 +417,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:446
Protected
Abstract
worker
@@ -428,7 +428,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:472
Methods
@@ -461,7 +461,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/abstract-pool.ts:796
+Defined in src/pools/abstract-pool.ts:1596
Protected
after Task Execution Hook
@@ -508,7 +508,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1035
Protected
after Worker Node Setup
@@ -528,7 +528,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1346
Protected
before Task Execution Hook
@@ -553,7 +553,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1005
Private
build Tasks Queue Options
@@ -566,7 +566,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:600
Private
check And Emit Dynamic Worker Creation Events
@@ -574,7 +574,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1571
Private
check And Emit Task Execution Events
@@ -582,7 +582,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1559
Private
check And Emit Task Queuing Events
@@ -590,7 +590,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1565
Private
check Message Worker Id
+Defined in src/pools/abstract-pool.ts:494
Private
check Number Of Workers
@@ -624,7 +624,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:170
Private
check Pool Options
@@ -637,7 +637,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:188
Private
check Valid Worker Choice Strategy Options
@@ -650,7 +650,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:217
Private
choose Worker Node
@@ -663,7 +663,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1162
Protected
create And Setup Dynamic Worker Node
@@ -675,7 +675,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1252
Protected
create And Setup Worker Node
@@ -687,7 +687,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1208
Protected
Abstract
create Worker
@@ -699,7 +699,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1201
Private
delete Task Function Worker Usages
@@ -712,7 +712,7 @@ Can be overridden.
name : string
Returns void
+Defined in src/pools/abstract-pool.ts:855
Private
dequeue Task
@@ -725,7 +725,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1661
Protected
Abstract
deregister Worker Message Listener
@@ -765,7 +765,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1333
+Defined in src/pools/abstract-pool.ts:940
Protected
Abstract
destroy Worker Node
@@ -796,7 +796,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:981
+Defined in src/pools/abstract-pool.ts:565
Private
enqueue Task
@@ -836,7 +836,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1655
+Defined in src/pools/abstract-pool.ts:870
Private
execute Task
@@ -891,7 +891,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1649
Protected
flush Tasks Queue
@@ -904,7 +904,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1669
Private
flush Tasks Queues
@@ -912,7 +912,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1679
Protected
get Worker Info
@@ -932,7 +932,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1585
Private
get Worker Node Key By Worker
@@ -952,7 +952,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:513
Private
get Worker Node Key By Worker Id
@@ -972,7 +972,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:525
Private
handle Task Execution Response
@@ -985,7 +985,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1531
Private
handle Worker Ready Response
@@ -998,7 +998,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1515
Private
has Back Pressure
@@ -1006,7 +1006,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1634
+Defined in src/pools/abstract-pool.ts:783
has Worker Node Back Pressure
+Defined in src/pools/abstract-pool.ts:1627
Private
initialize Event Emitter
@@ -1056,7 +1056,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:264
Protected
internal Busy
@@ -1068,7 +1068,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:667
Protected
Abstract
is Main
@@ -1079,7 +1079,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:996
+Defined in src/pools/abstract-pool.ts:835
Private
redistribute Queued Tasks
@@ -1105,7 +1105,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1389
Protected
Abstract
register Once Worker Message Listener
@@ -1145,7 +1145,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1320
Protected
Abstract
register Worker Message Listener
@@ -1185,7 +1185,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1307
+Defined in src/pools/abstract-pool.ts:819
Private
remove Worker Node
@@ -1225,7 +1225,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1618
Protected
send Kill Message To Worker
@@ -1238,7 +1238,7 @@ Can be overridden.
workerNodeKey : number
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:953
Protected
Abstract
send Startup Message To Worker
@@ -1257,7 +1257,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1370
Private
send Statistics Message To Worker
@@ -1276,7 +1276,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1377
Private
send Task Function Operation To Worker
@@ -1291,7 +1291,7 @@ Can be overridden.
Returns Promise < boolean >
+Defined in src/pools/abstract-pool.ts:686
Private
send Task Function Operation To Workers
@@ -1304,7 +1304,7 @@ Can be overridden.
Returns Promise < boolean >
+Defined in src/pools/abstract-pool.ts:727
Protected
Abstract
send To Worker
@@ -1333,7 +1333,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1190
+Defined in src/pools/abstract-pool.ts:848
Private
set Task Stealing
@@ -1362,7 +1362,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:620
+Defined in src/pools/abstract-pool.ts:579
Private
set Tasks Queue Size
@@ -1395,7 +1395,7 @@ Can be overridden.
size : number
Returns void
+Defined in src/pools/abstract-pool.ts:614
Private
set Tasks Stealing On Back Pressure
@@ -1403,7 +1403,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:633
+Defined in src/pools/abstract-pool.ts:532
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:551
Protected
setup Hook
@@ -1460,7 +1460,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:989
Private
shall Create Dynamic Worker
@@ -1472,7 +1472,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1179
Private
shall Execute Task
@@ -1485,7 +1485,7 @@ Can be overridden.
workerNodeKey : number
Returns boolean
+Defined in src/pools/abstract-pool.ts:861
Private
shall Update Task Function Worker Usage
@@ -1505,7 +1505,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1068
+Defined in src/pools/abstract-pool.ts:924
Private
task Stealing On Empty Queue
@@ -1530,7 +1530,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1429
Private
tasks Queue Size
@@ -1543,7 +1543,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:1665
Private
tasks Stealing On Back Pressure
@@ -1556,7 +1556,7 @@ Can be overridden.
workerId : number
Returns void
+Defined in src/pools/abstract-pool.ts:1457
Private
unset Task Stealing
@@ -1564,7 +1564,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:627
Private
unset Tasks Stealing On Back Pressure
@@ -1572,7 +1572,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:640
Private
update Elu Worker Usage
@@ -1587,7 +1587,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1122
Private
update Run Time Worker Usage
@@ -1602,7 +1602,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1095
Private
update Task Statistics Worker Usage
@@ -1617,7 +1617,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1077
Private
update Task Stolen Statistics Worker Usage
@@ -1632,7 +1632,7 @@ Can be overridden.
taskName : string
Returns void
+Defined in src/pools/abstract-pool.ts:1410
Private
update Wait Time Worker Usage
@@ -1647,7 +1647,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:1109
Protected
worker Listener
@@ -1674,7 +1674,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1497
+Defined in src/worker/abstract-worker.ts:91
Protected
last Task Timestamp
last Task Timestamp : number
@@ -187,7 +187,7 @@
+Defined in src/worker/abstract-worker.ts:71
Private
Readonly
main Worker
main Worker : MainWorker
@@ -195,7 +195,7 @@
+Defined in src/worker/abstract-worker.ts:92
Protected
opts
@@ -203,7 +203,7 @@
+Defined in src/worker/abstract-worker.ts:94
Protected
statistics
@@ -211,7 +211,7 @@
+Defined in src/worker/abstract-worker.ts:75
Protected
task Functions
@@ -219,7 +219,7 @@
+Defined in src/worker/abstract-worker.ts:67
async Id
@@ -271,7 +271,7 @@ If a task function with the same name already exists, it is replaced.
Optional
name : string
+Defined in src/worker/abstract-worker.ts:587
bind
@@ -309,7 +309,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:439
Private
check Message Worker Id
+Defined in src/worker/abstract-worker.ts:405
Private
check Statistics
@@ -338,7 +338,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:611
Private
check Task Functions
@@ -357,7 +357,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:118
Private
check Worker Options
@@ -370,7 +370,7 @@ If a task function with the same name already exists, it is replaced.
Returns void
+Defined in src/worker/abstract-worker.ts:108
emit Destroy
@@ -399,7 +399,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:596
+Defined in src/worker/abstract-worker.ts:454
Protected
handle Error
@@ -433,7 +433,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:485
Protected
handle Kill Message
@@ -452,7 +452,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:371
Protected
Abstract
handle Ready Message
@@ -471,7 +471,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:299
Protected
handle Task Function Operation Message
@@ -484,7 +484,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:326
has Task Function
@@ -504,7 +504,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:162
list Task Function Names
@@ -516,7 +516,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:243
Protected
message Listener
@@ -535,7 +535,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:306
remove Task Function
@@ -555,7 +555,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:214
Protected
run
@@ -574,7 +574,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:494
Protected
run Async
@@ -598,7 +598,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:555
run In Async Scope
@@ -677,7 +677,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:521
Protected
send Task Function Names To Main Worker
@@ -688,7 +688,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:473
Protected
Abstract
send To Main Worker
@@ -707,7 +707,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:466
set Default Task Function
@@ -727,7 +727,7 @@ then restore the original execution context.
+Defined in src/worker/abstract-worker.ts:270
Private
start Check Active
@@ -738,7 +738,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:418
Private
stop Check Active
@@ -749,7 +749,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:429
trigger Async Id
@@ -768,7 +768,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:617
Static
bind
diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html
index 990a350f..1e4d2785 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 b1888a6f..c2b001ef 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
@@ -128,7 +128,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
@@ -148,7 +148,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:91
Protected
last Task Timestamp
last Task Timestamp : number
@@ -157,7 +157,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:71
Protected
opts
@@ -166,7 +166,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:94
Protected
statistics
@@ -175,7 +175,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:75
Protected
task Functions
@@ -184,7 +184,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:67
Accessors
@@ -198,7 +198,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/cluster-worker.ts:63
+Defined in src/worker/abstract-worker.ts:454
+Defined in src/worker/abstract-worker.ts:485
Protected
handle Kill Message
+Defined in src/worker/abstract-worker.ts:371
Protected
handle Ready Message
+Defined in src/worker/cluster-worker.ts:45
Protected
handle Task Function Operation Message
+Defined in src/worker/abstract-worker.ts:326
+Defined in src/worker/abstract-worker.ts:162
+Defined in src/worker/abstract-worker.ts:243
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:306
+Defined in src/worker/abstract-worker.ts:214
+Defined in src/worker/abstract-worker.ts:494
+Defined in src/worker/abstract-worker.ts:555
+Defined in src/worker/abstract-worker.ts:521
Protected
send Task Function Names To Main Worker
+Defined in src/worker/abstract-worker.ts:473
Protected
send To Main Worker
+Defined in src/worker/cluster-worker.ts:68
+Defined in src/worker/abstract-worker.ts:270
trigger Async Id
diff --git a/docs/classes/Deque.html b/docs/classes/Deque.html
index 8035bf37..fb015f84 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/pools/selection-strategies/worker-choice-strategy-context.ts:159
+Defined in src/pools/pool.ts:149
Optional
exit Handler
@@ -105,7 +105,7 @@
+Defined in src/pools/pool.ts:155
Optional
message Handler
@@ -116,7 +116,7 @@
+Defined in src/pools/pool.ts:143
Optional
online Handler
@@ -127,7 +127,7 @@
+Defined in src/pools/pool.ts:137
Optional
restart Worker On Error
restart Worker On Error ?: boolean
@@ -136,7 +136,7 @@
+Defined in src/pools/pool.ts:175
+Defined in src/pools/cluster/fixed.ts:22
Optional
start Workers
start Workers ?: boolean
@@ -158,7 +158,7 @@
+Defined in src/pools/pool.ts:161
Optional
tasks Queue Options
@@ -167,7 +167,7 @@
+Defined in src/pools/pool.ts:191
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:167
Optional
worker Choice Strategy Options
@@ -188,7 +188,7 @@
+Defined in src/pools/pool.ts:171
+Defined in src/pools/pool.ts:238
Readonly
enable Tasks Queue
enable Tasks Queue : ( ( enable , tasksQueueOptions ? ) => void )
@@ -171,7 +171,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns void
+Defined in src/pools/pool.ts:325
Readonly
execute
execute : ( ( data ? , name ? , transferList ? ) => Promise < Response > )
@@ -206,7 +206,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:247
Readonly
has Task Function
has Task Function : ( ( name ) => boolean )
@@ -231,7 +231,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:266
Readonly
has Worker Node Back Pressure
has Worker Node Back Pressure : ( ( workerNodeKey ) => boolean )
@@ -256,7 +256,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:223
Readonly
info
@@ -264,7 +264,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:209
Readonly
list Task Function Names
list Task Function Names : ( ( ) => string [] )
@@ -281,7 +281,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:293
Readonly
remove Task Function
remove Task Function : ( ( name ) => Promise < boolean > )
@@ -306,7 +306,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:287
Readonly
set Default Task Function
set Default Task Function : ( ( name ) => Promise < boolean > )
@@ -331,7 +331,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:300
Readonly
set Tasks Queue Options
set Tasks Queue Options : ( ( tasksQueueOptions ) => void )
@@ -355,7 +355,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns void
+Defined in src/pools/pool.ts:334
Readonly
set Worker Choice Strategy
set Worker Choice Strategy : ( ( workerChoiceStrategy , workerChoiceStrategyOptions ? ) => void )
@@ -384,7 +384,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns void
+Defined in src/pools/pool.ts:307
Readonly
set Worker Choice Strategy Options
set Worker Choice Strategy Options : ( ( workerChoiceStrategyOptions ) => void )
@@ -408,7 +408,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns void
+Defined in src/pools/pool.ts:316
Readonly
start
start : ( ( ) => void )
@@ -424,7 +424,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns void
+Defined in src/pools/pool.ts:255
Readonly
Internal
worker Nodes
@@ -432,7 +432,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/pool.ts:215
+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 )
@@ -126,7 +126,7 @@ If undefined
is returned, the caller retry.
Returns void
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:210
Readonly
strategy Policy
@@ -134,7 +134,7 @@ If undefined
is returned, the caller retry.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:172
Readonly
task Statistics Requirements
@@ -142,7 +142,7 @@ If undefined
is returned, the caller retry.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:176
Readonly
update
update : ( ( workerNodeKey ) => boolean )
@@ -165,7 +165,7 @@ This is called after a task has been executed on a worker node.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:189
+Defined in src/pools/worker.ts:324
Readonly
dequeue Task
dequeue Task : ( ( ) => undefined | Task < Data > )
@@ -140,7 +140,7 @@
+Defined in src/pools/worker.ts:286
Readonly
enqueue Task
enqueue Task : ( ( task ) => number )
@@ -165,7 +165,7 @@
+Defined in src/pools/worker.ts:273
Readonly
get Task Function Worker Usage
get Task Function Worker Usage : ( ( name ) => undefined | WorkerUsage )
@@ -190,7 +190,7 @@
+Defined in src/pools/worker.ts:317
Readonly
has Back Pressure
has Back Pressure : ( ( ) => boolean )
@@ -207,7 +207,7 @@
+Defined in src/pools/worker.ts:302
Readonly
info
@@ -215,7 +215,7 @@
+Defined in src/pools/worker.ts:234
Optional
Readonly
message Channel
message Channel ?: MessageChannel
@@ -223,7 +223,7 @@
+Defined in src/pools/worker.ts:247
Optional
on Back Pressure
@@ -231,7 +231,7 @@
+Defined in src/pools/worker.ts:256
Optional
on Empty Queue
@@ -239,7 +239,7 @@
+Defined in src/pools/worker.ts:260
Readonly
pop Task
pop Task : ( ( ) => undefined | Task < Data > )
@@ -256,7 +256,7 @@
+Defined in src/pools/worker.ts:292
Readonly
reset Usage
reset Usage : ( ( ) => void )
@@ -272,7 +272,7 @@
Returns void
+Defined in src/pools/worker.ts:306
Optional
strategy Data
@@ -281,7 +281,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
@@ -290,7 +290,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 )
@@ -307,7 +307,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 )
@@ -332,7 +332,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
@@ -340,7 +340,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
@@ -348,7 +348,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:157
Optional
Readonly
ready
ready ?: boolean
@@ -117,7 +117,7 @@
+Defined in src/utility-types.ts:149
Optional
Readonly
statistics
@@ -125,7 +125,7 @@
+Defined in src/utility-types.ts:145
Optional
Readonly
task Function
task Function ?: string
@@ -133,7 +133,7 @@
+Defined in src/utility-types.ts:133
Optional
Readonly
task Function Name
task Function Name ?: string
@@ -141,7 +141,7 @@
+Defined in src/utility-types.ts:137
Optional
Readonly
task Function Names
task Function Names ?: string []
@@ -149,7 +149,7 @@
+Defined in src/utility-types.ts:141
Optional
Readonly
task Function Operation
task Function Operation ?: "add" | "default" | "remove"
@@ -162,7 +162,7 @@
+Defined in src/utility-types.ts:125
Optional
Readonly
task Function Operation Status
task Function Operation Status ?: boolean
@@ -170,7 +170,7 @@
+Defined in src/utility-types.ts:129
Optional
Readonly
task Id
task Id ?: string
@@ -179,7 +179,7 @@
+Defined in src/utility-types.ts:95
Optional
Readonly
task Performance
@@ -187,7 +187,7 @@
+Defined in src/utility-types.ts:118
Optional
Readonly
timestamp
timestamp ?: number
@@ -196,7 +196,7 @@
+Defined in src/utility-types.ts:91
Optional
Readonly
transfer List
transfer List ?: TransferListItem []
@@ -205,7 +205,7 @@
+Defined in src/utility-types.ts:87
Optional
Readonly
worker Error
@@ -213,7 +213,7 @@
+Defined in src/utility-types.ts:114
Optional
Readonly
worker Id
worker Id ?: number
@@ -222,7 +222,7 @@
+Defined in src/utility-types.ts:75
+Defined in src/pools/pool.ts:82
Readonly
started
started : boolean
+Defined in src/pools/pool.ts:62
Optional
Readonly
stolen Tasks
stolen Tasks ?: number
+Defined in src/pools/pool.ts:80
Readonly
strategy
strategy : "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+Defined in src/pools/pool.ts:64
Readonly
type
type : "fixed" | "dynamic"
+Defined in src/pools/pool.ts:60
Optional
Readonly
utilization
utilization ?: number
@@ -160,12 +160,12 @@
+Defined in src/pools/pool.ts:68
Readonly
version
version : string
+Defined in src/pools/pool.ts:59
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:88
Readonly
worker
worker : "thread" | "cluster"
+Defined in src/pools/pool.ts:61
Readonly
worker Nodes
worker Nodes : number
@@ -194,7 +194,7 @@
+Defined in src/pools/pool.ts:70
+Defined in src/pools/pool.ts:149
Optional
exit Handler
@@ -98,7 +98,7 @@
Default Value () => {}
+Defined in src/pools/pool.ts:155
Optional
message Handler
@@ -108,7 +108,7 @@
Default Value () => {}
+Defined in src/pools/pool.ts:143
Optional
online Handler
@@ -118,7 +118,7 @@
Default Value () => {}
+Defined in src/pools/pool.ts:137
Optional
restart Worker On Error
restart Worker On Error ?: boolean
@@ -126,7 +126,7 @@
+Defined in src/pools/pool.ts:175
Optional
start Workers
start Workers ?: boolean
@@ -137,7 +137,7 @@
Copy
+Defined in src/pools/pool.ts:161
Optional
tasks Queue Options
@@ -145,7 +145,7 @@
+Defined in src/pools/pool.ts:191
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:167
Optional
worker Choice Strategy Options
@@ -164,7 +164,7 @@
+Defined in src/pools/pool.ts:171
+Defined in src/utility-types.ts:178
+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
Optional
Readonly
worker Id
worker Id ?: number
@@ -98,7 +98,7 @@
+Defined in src/utility-types.ts:75
+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:117
Optional
Readonly
tasks Stealing On Back Pressure
tasks Stealing On Back Pressure ?: boolean
@@ -82,7 +82,7 @@
Copy
+Defined in src/pools/pool.ts:123
+Defined in src/pools/pool.ts:149
Optional
exit Handler
@@ -94,7 +94,7 @@
+Defined in src/pools/pool.ts:155
Optional
message Handler
@@ -105,7 +105,7 @@
+Defined in src/pools/pool.ts:143
Optional
online Handler
@@ -116,7 +116,7 @@
+Defined in src/pools/pool.ts:137
Optional
restart Worker On Error
restart Worker On Error ?: boolean
@@ -125,7 +125,7 @@
+Defined in src/pools/pool.ts:175
Optional
start Workers
start Workers ?: boolean
@@ -137,7 +137,7 @@
+Defined in src/pools/pool.ts:161
Optional
tasks Queue Options
@@ -146,7 +146,7 @@
+Defined in src/pools/pool.ts:191
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:167
Optional
worker Choice Strategy Options
@@ -167,7 +167,7 @@
+Defined in src/pools/pool.ts:171
+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/utility-types.ts:14
+Defined in src/pools/worker.ts:143
Optional
task Function Names
task Function Names ?: 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