From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Date: Fri, 9 Jun 2023 19:54:12 +0000 (+0000)
Subject: chore: generate documentation
X-Git-Tag: v2.6.0~1
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=5e5a659e2b415c7d533dad095eda082989983f8e;p=poolifier.git
chore: generate documentation
---
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 01b34541..002878a8 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:45
@@ -164,7 +164,7 @@
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:85
Protected
Readonly
file Path
file Path : string
@@ -190,7 +190,7 @@
+Defined in src/pools/abstract-pool.ts:87
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -198,7 +198,7 @@
+Defined in src/pools/abstract-pool.ts:86
Protected
Readonly
opts
@@ -206,7 +206,7 @@
+Defined in src/pools/abstract-pool.ts:88
Protected
promise Response Map
@@ -219,16 +219,15 @@
+Defined in src/pools/abstract-pool.ts:64
Protected
worker Choice Strategy Context
+Defined in src/pools/abstract-pool.ts:72
Readonly
worker Nodes
@@ -237,7 +236,7 @@
+Defined in src/pools/abstract-pool.ts:51
Protected
full
@@ -263,7 +262,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:371
+Defined in src/pools/abstract-pool.ts:220
Protected
Abstract
max Size
@@ -286,7 +285,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:288
Protected
Abstract
min Size
@@ -297,7 +296,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:283
Protected
Abstract
type
@@ -309,7 +308,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:273
Protected
Abstract
worker
@@ -320,7 +319,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:278
Protected
Abstract
after Worker Setup
@@ -367,7 +366,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:663
Protected
before Task Execution Hook
@@ -392,7 +391,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:465
Private
build Tasks Queue Options
@@ -405,7 +404,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:358
Private
check And Emit Events
@@ -413,7 +412,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:736
Private
check File Path
@@ -426,7 +425,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:122
Private
check Number Of Workers
@@ -439,7 +438,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:131
Private
check Pool Options
@@ -452,7 +451,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:149
Private
check Valid Tasks Queue Options
@@ -465,7 +464,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:204
Private
check Valid Worker Choice Strategy
@@ -478,7 +477,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:176
Private
check Valid Worker Choice Strategy Options
@@ -491,7 +490,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:186
Protected
choose Worker Node
@@ -504,7 +503,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:605
Protected
create And Setup Worker
@@ -516,7 +515,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:670
Protected
Abstract
create Worker
@@ -527,7 +526,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:654
Private
dequeue Task
@@ -540,7 +539,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:817
+Defined in src/pools/abstract-pool.ts:426
Protected
Abstract
destroy Worker
@@ -571,7 +570,7 @@ Can be overridden.
Returns void | Promise < void >
+Defined in src/pools/abstract-pool.ts:441
+Defined in src/pools/abstract-pool.ts:336
Private
enqueue Task
@@ -611,7 +610,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:813
+Defined in src/pools/abstract-pool.ts:391
Private
execute Task
@@ -652,7 +651,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:808
Private
flush Tasks Queue
@@ -665,7 +664,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:825
Private
flush Tasks Queues
@@ -673,7 +672,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:836
Private
get Task Statistics
@@ -686,7 +685,7 @@ Can be overridden.
worker : Worker
+Defined in src/pools/abstract-pool.ts:887
Private
get Worker Node Key
@@ -706,7 +705,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:296
Private
get Worker Usage
@@ -719,7 +718,7 @@ Can be overridden.
worker : Worker
+Defined in src/pools/abstract-pool.ts:854
Protected
internal Busy
@@ -727,7 +726,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:382
Protected
Abstract
is Main
@@ -738,7 +737,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:456
Private
push Worker Node
@@ -758,7 +757,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:766
Protected
Abstract
register Worker Message Listener
@@ -798,7 +797,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:647
Private
remove Worker Node
@@ -817,7 +816,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:800
Protected
Abstract
send To Worker
@@ -841,7 +840,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:636
+Defined in src/pools/abstract-pool.ts:348
+Defined in src/pools/abstract-pool.ts:303
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:325
Private
set Worker Node Tasks Usage
@@ -930,7 +929,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:753
Private
set Worker Statistics
@@ -943,7 +942,7 @@ Can be overridden.
worker : Worker
Returns void
+Defined in src/pools/abstract-pool.ts:842
Protected
setup Hook
@@ -955,7 +954,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:449
Private
tasks Queue Size
@@ -968,7 +967,7 @@ Can be overridden
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:821
Private
update Elu Worker Usage
@@ -983,7 +982,7 @@ Can be overridden
message : MessageValue < Response , unknown , Worker | MessagePort >
Returns void
+Defined in src/pools/abstract-pool.ts:555
Private
update Run Time Worker Usage
@@ -998,7 +997,7 @@ Can be overridden
message : MessageValue < Response , unknown , Worker | MessagePort >
Returns void
+Defined in src/pools/abstract-pool.ts:497
Private
update Wait Time Worker Usage
@@ -1013,7 +1012,7 @@ Can be overridden
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:525
Protected
worker Listener
@@ -1040,7 +1039,7 @@ Can be overridden
+Defined in src/pools/abstract-pool.ts:705
+Defined in src/worker/abstract-worker.ts:46
Protected
main Worker
main Worker : undefined | null | MainWorker
@@ -172,7 +172,7 @@
+Defined in src/worker/abstract-worker.ts:70
Protected
Readonly
opts
@@ -180,7 +180,7 @@
+Defined in src/worker/abstract-worker.ts:71
Protected
statistics
@@ -188,7 +188,7 @@
+Defined in src/worker/abstract-worker.ts:50
Protected
task Functions
@@ -196,7 +196,7 @@
+Defined in src/worker/abstract-worker.ts:42
bind
@@ -255,7 +255,7 @@
Returns void
+Defined in src/worker/abstract-worker.ts:197
Private
check Task Functions
@@ -274,7 +274,7 @@
Returns void
+Defined in src/worker/abstract-worker.ts:109
Private
check Worker Options
Returns void
+Defined in src/worker/abstract-worker.ts:97
emit Destroy
@@ -316,7 +316,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:307
Protected
get Main Worker
@@ -328,7 +328,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:178
Private
get Task Function
@@ -347,7 +347,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:291
Protected
handle Error
@@ -367,7 +367,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:212
Protected
message Listener
@@ -386,7 +386,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:149
Protected
run Async
@@ -410,7 +410,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:255
run In Async Scope
@@ -489,7 +489,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:222
Protected
Abstract
send To Main Worker
@@ -508,7 +508,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:190
trigger Async Id
diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html
index 87804600..8378878d 100644
--- a/docs/classes/CircularArray.html
+++ b/docs/classes/CircularArray.html
@@ -31,7 +31,7 @@
+Defined in src/circular-array.ts:8
+Defined in src/circular-array.ts:11
Properties
@@ -153,7 +153,7 @@ when they will be absent when used in a 'with' statement.
size
size : number
+Defined in src/circular-array.ts:9
Static
Readonly
[species]
[species] : ArrayConstructor
@@ -206,7 +206,7 @@ when they will be absent when used in a 'with' statement.
size : number
Returns void
+Defined in src/circular-array.ts:88
concat
@@ -222,7 +222,7 @@ when they will be absent when used in a 'with' statement.
Inherit Doc
+Defined in src/circular-array.ts:39
copy Within
@@ -263,7 +263,7 @@ is treated as length+end. If start is omitted, 0
is used.
Returns boolean
+Defined in src/circular-array.ts:80
entries
@@ -729,7 +729,7 @@ thisArg is omitted, undefined is used as the this value.
Returns boolean
+Defined in src/circular-array.ts:84
includes
@@ -910,7 +910,7 @@ If the array is empty, undefined is returned and the array is not modified.
Inherit Doc
+Defined in src/circular-array.ts:21
reduce
@@ -1145,7 +1145,7 @@ If the array is empty, undefined is returned and the array is not modified.
size : number
Returns void
+Defined in src/circular-array.ts:68
reverse
@@ -1301,7 +1301,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
Inherit Doc
+Defined in src/circular-array.ts:54
to Locale String
@@ -1341,7 +1341,7 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
Inherit Doc
+Defined in src/circular-array.ts:30
values
diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html
index e9811811..e2f4c930 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
@@ -116,7 +116,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
@@ -136,7 +136,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:66
Protected
last Task Timestamp
last Task Timestamp : number
@@ -145,7 +145,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:46
Protected
main Worker
main Worker : undefined | null | Worker
@@ -154,7 +154,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:70
Protected
Readonly
opts
@@ -163,7 +163,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:71
Protected
statistics
@@ -172,7 +172,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:50
Protected
task Functions
@@ -181,7 +181,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:42
+Defined in src/worker/abstract-worker.ts:178
+Defined in src/worker/cluster-worker.ts:52
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:149
+Defined in src/worker/abstract-worker.ts:255
+Defined in src/worker/abstract-worker.ts:222
Protected
send To Main Worker
+Defined in src/worker/cluster-worker.ts:47
trigger Async Id
diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html
index 07b7c79b..b6636b7e 100644
--- a/docs/classes/DynamicClusterPool.html
+++ b/docs/classes/DynamicClusterPool.html
@@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/cluster/dynamic.ts:15
@@ -141,7 +141,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/cluster/dynamic.ts:27
Properties
@@ -159,7 +159,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:54
Protected
Readonly
file Path
file Path : string
@@ -168,7 +168,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:87
Protected
Readonly
max
max : number
@@ -176,7 +176,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/cluster/dynamic.ts:29
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -185,7 +185,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:86
Protected
Readonly
opts
@@ -194,7 +194,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/cluster/fixed.ts:54
Protected
promise Response Map
@@ -208,17 +208,16 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:64
Protected
worker Choice Strategy Context
+Defined in src/pools/abstract-pool.ts:72
Readonly
worker Nodes
@@ -227,7 +226,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:51
+Defined in src/pools/abstract-pool.ts:371
+Defined in src/pools/abstract-pool.ts:220
+Defined in src/pools/cluster/dynamic.ts:42
+Defined in src/pools/cluster/fixed.ts:110
+Defined in src/pools/cluster/dynamic.ts:37
+Defined in src/pools/cluster/fixed.ts:105
Protected
after Worker Setup
+Defined in src/pools/cluster/fixed.ts:94
Protected
before Task Execution Hook
+Defined in src/pools/abstract-pool.ts:465
Protected
choose Worker Node
+Defined in src/pools/abstract-pool.ts:605
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:670
+Defined in src/pools/cluster/fixed.ts:89
+Defined in src/pools/abstract-pool.ts:426
+Defined in src/pools/cluster/fixed.ts:70
+Defined in src/pools/abstract-pool.ts:336
+Defined in src/pools/abstract-pool.ts:391
+Defined in src/pools/abstract-pool.ts:382
+Defined in src/pools/cluster/fixed.ts:65
Protected
register Worker Message Listener
+Defined in src/pools/cluster/fixed.ts:81
+Defined in src/pools/cluster/fixed.ts:76
+Defined in src/pools/abstract-pool.ts:348
+Defined in src/pools/abstract-pool.ts:303
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:325
+Defined in src/pools/cluster/fixed.ts:60
+Defined in src/pools/abstract-pool.ts:705
+Defined in src/pools/pool.ts:189
Readonly
info
@@ -163,7 +163,7 @@
+Defined in src/pools/pool.ts:166
set Tasks Queue Options
set Tasks Queue Options : ( ( tasksQueueOptions ) => void )
@@ -187,7 +187,7 @@
Returns void
+Defined in src/pools/pool.ts:227
set Worker Choice Strategy
set Worker Choice Strategy : ( ( workerChoiceStrategy , workerChoiceStrategyOptions ? ) => void )
@@ -216,7 +216,7 @@
Returns void
+Defined in src/pools/pool.ts:200
set Worker Choice Strategy Options
set Worker Choice Strategy Options : ( ( workerChoiceStrategyOptions ) => void )
@@ -240,7 +240,7 @@
Returns void
+Defined in src/pools/pool.ts:209
Readonly
worker Nodes
@@ -248,7 +248,7 @@
+Defined in src/pools/pool.ts:170
+Defined in src/pools/worker.ts:161
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:156
set Options
set Options : ( ( opts ) => void )
@@ -123,7 +123,7 @@
Returns void
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:181
Readonly
task Statistics Requirements
@@ -131,7 +131,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:150
update
update : ( ( workerNodeKey ) => boolean )
@@ -153,7 +153,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:162
+Defined in src/pools/worker.ts:79
median
median : number
@@ -70,7 +70,7 @@
+Defined in src/pools/worker.ts:75
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:120
+Defined in src/utility-types.ts:88
Optional
Readonly
task Error
@@ -122,7 +122,7 @@
+Defined in src/utility-types.ts:76
Optional
Readonly
task Performance
@@ -130,7 +130,7 @@
+Defined in src/utility-types.ts:80
Optional
Readonly
timestamp
timestamp ?: number
@@ -139,7 +139,7 @@
+Defined in src/pools/worker.ts:51
+Defined in src/pools/pool.ts:118
Optional
message Handler
@@ -99,7 +99,7 @@
+Defined in src/pools/pool.ts:106
Optional
online Handler
@@ -107,7 +107,7 @@
+Defined in src/pools/pool.ts:114
Optional
restart Worker On Error
restart Worker On Error ?: boolean
@@ -115,7 +115,7 @@
+Defined in src/pools/pool.ts:132
Optional
tasks Queue Options
@@ -123,7 +123,7 @@
+Defined in src/pools/pool.ts:148
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:124
Optional
worker Choice Strategy Options
@@ -141,7 +141,7 @@
+Defined in src/pools/pool.ts:128
+Defined in src/utility-types.ts:113
+Defined in src/pools/worker.ts:43
Optional
Readonly
timestamp
timestamp ?: number
@@ -80,7 +80,7 @@
+Defined in src/pools/worker.ts:51
+Defined in src/utility-types.ts:23
+Defined in src/utility-types.ts:37
+Defined in src/pools/worker.ts:114
Readonly
queued
queued : number
@@ -70,7 +70,7 @@
+Defined in src/pools/worker.ts:110
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:136
+Defined in src/pools/pool.ts:124
Optional
worker Choice Strategy Options
@@ -143,7 +143,7 @@
+Defined in src/pools/pool.ts:128
+Defined in src/pools/thread/fixed.ts:27
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:81
Optional
wait Time
@@ -77,7 +77,7 @@
Default Value { median: false }
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:87
Optional
weights
weights ?: Record < number , number >
@@ -88,7 +88,7 @@ Weight is the tasks maximum average or median runtime in milliseconds.
Default Value Computed worker weights automatically given the CPU performance.
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:100
+Defined in src/pools/worker.ts:179
+Defined in src/worker/worker-options.ts:51
+Defined in src/pools/worker.ts:134
Worker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.