From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Date: Sat, 1 Jul 2023 17:32:36 +0000 (+0000)
Subject: chore: generate documentation
X-Git-Tag: v2.6.7~18^2
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=6d6c7ed0c2c3c83cefae4d8cd5bc9393126bba70;hp=-c;p=poolifier.git
chore: generate documentation
---
6d6c7ed0c2c3c83cefae4d8cd5bc9393126bba70
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 9283ff10..c6bf43ba 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:46
@@ -167,7 +167,7 @@
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:86
Protected
Readonly
file Path
file Path : string
@@ -193,7 +193,7 @@
+Defined in src/pools/abstract-pool.ts:88
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -201,7 +201,7 @@
+Defined in src/pools/abstract-pool.ts:87
Protected
Readonly
opts
@@ -209,7 +209,7 @@
+Defined in src/pools/abstract-pool.ts:89
Protected
promise Response Map
@@ -222,7 +222,7 @@
+Defined in src/pools/abstract-pool.ts:65
Protected
worker Choice Strategy Context
@@ -230,7 +230,7 @@
+Defined in src/pools/abstract-pool.ts:73
Readonly
worker Nodes
@@ -239,7 +239,7 @@
+Defined in src/pools/abstract-pool.ts:52
Protected
full
@@ -265,7 +265,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:390
+Defined in src/pools/abstract-pool.ts:240
Protected
Abstract
max Size
@@ -288,7 +288,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:307
Protected
Abstract
min Size
@@ -299,7 +299,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:302
Protected
Abstract
type
@@ -311,7 +311,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:292
Protected
Abstract
worker
@@ -322,7 +322,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:297
Protected
after Worker Setup
@@ -369,7 +369,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:696
Protected
before Task Execution Hook
@@ -394,7 +394,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:488
Private
build Tasks Queue Options
@@ -407,7 +407,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:377
Private
check And Emit Events
@@ -415,7 +415,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:796
Private
check File Path
@@ -428,7 +428,7 @@ Can be overridden.
filePath : string
Returns void
+Defined in src/pools/abstract-pool.ts:123
Private
check Number Of Workers
@@ -441,7 +441,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:132
Private
check Pool Options
@@ -454,7 +454,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:150
Private
check Valid Tasks Queue Options
@@ -467,7 +467,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:215
Private
check Valid Worker Choice Strategy
@@ -480,7 +480,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:177
Private
check Valid Worker Choice Strategy Options
@@ -493,7 +493,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:187
Private
choose Worker Node
@@ -506,7 +506,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:638
Protected
create And Setup Dynamic Worker
@@ -518,7 +518,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:739
Protected
create And Setup Worker
@@ -530,7 +530,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:706
Protected
Abstract
create Worker
@@ -542,7 +542,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:688
Private
dequeue Task
@@ -555,7 +555,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:883
+Defined in src/pools/abstract-pool.ts:449
Protected
Abstract
destroy Worker
@@ -586,7 +586,7 @@ Can be overridden.
Returns void | Promise < void >
+Defined in src/pools/abstract-pool.ts:464
+Defined in src/pools/abstract-pool.ts:355
Private
enqueue Task
@@ -626,7 +626,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:879
+Defined in src/pools/abstract-pool.ts:415
Private
execute Task
@@ -667,7 +667,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:874
Private
flush Tasks Queue
@@ -680,7 +680,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:895
Private
flush Tasks Queues
@@ -688,7 +688,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:907
Private
get Worker Node Key
@@ -708,7 +708,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:315
Private
get Worker Usage
@@ -721,7 +721,7 @@ Can be overridden.
Optional
workerNodeKey : number
+Defined in src/pools/abstract-pool.ts:925
Protected
internal Busy
@@ -733,7 +733,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:406
Protected
Abstract
is Main
@@ -744,7 +744,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:479
Private
push Worker Node
@@ -764,7 +764,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:826
Private
register Worker Message Listener
@@ -804,7 +804,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:676
Private
remove Worker Node
@@ -823,7 +823,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:866
Protected
Abstract
send To Worker
@@ -847,7 +847,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:665
+Defined in src/pools/abstract-pool.ts:367
+Defined in src/pools/abstract-pool.ts:322
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:344
Private
set Worker Node Tasks Usage
@@ -936,7 +936,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:813
Private
set Worker Statistics
@@ -949,7 +949,7 @@ Can be overridden.
worker : Worker
Returns void
+Defined in src/pools/abstract-pool.ts:913
Protected
setup Hook
@@ -961,7 +961,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:472
Private
shall Create Dynamic Worker
@@ -973,7 +973,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:655
Private
tasks Max Queue Size
@@ -986,7 +986,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:891
Private
tasks Queue Size
@@ -999,7 +999,7 @@ Can be overridden.
workerNodeKey : number
Returns number
+Defined in src/pools/abstract-pool.ts:887
Private
update Elu Worker Usage
@@ -1014,7 +1014,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:586
Private
update Run Time Worker Usage
@@ -1029,7 +1029,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:526
Private
update Task Statistics Worker Usage
@@ -1044,7 +1044,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:514
Private
update Wait Time Worker Usage
@@ -1059,7 +1059,7 @@ Can be overridden.
task : Task < Data >
Returns void
+Defined in src/pools/abstract-pool.ts:555
Protected
worker Listener
@@ -1086,7 +1086,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:764
+Defined in src/worker/abstract-worker.ts:46
Protected
Readonly
main Worker
main Worker : MainWorker
@@ -173,7 +173,7 @@
+Defined in src/worker/abstract-worker.ts:70
Protected
Readonly
opts
@@ -181,7 +181,7 @@
+Defined in src/worker/abstract-worker.ts:71
Protected
statistics
@@ -189,7 +189,7 @@
+Defined in src/worker/abstract-worker.ts:50
Protected
task Functions
@@ -197,7 +197,7 @@
+Defined in src/worker/abstract-worker.ts:42
Methods
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:306
Private
begin Task Performance
+Defined in src/worker/abstract-worker.ts:295
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:283
Protected
check Alive
@@ -256,7 +256,7 @@
Returns void
+Defined in src/worker/abstract-worker.ts:192
Private
check Statistics
@@ -264,7 +264,7 @@
Returns void
+Defined in src/worker/abstract-worker.ts:318
Private
check Task Functions
@@ -283,7 +283,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
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:302
Private
end Task Performance
@@ -325,7 +325,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:303
Protected
get Main Worker
@@ -337,7 +337,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:173
Private
get Task Function
@@ -356,7 +356,7 @@ never be called.
+Defined in src/worker/abstract-worker.ts:286
Protected
handle Error
@@ -372,11 +372,11 @@ never be called.
-Returns string Message of the error.
+Returns string The error message.
+Defined in src/worker/abstract-worker.ts:207
Protected
message Listener
@@ -395,7 +395,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:149
Protected
run Async
@@ -419,7 +419,7 @@ never be called.
Returns void
+Defined in src/worker/abstract-worker.ts:250
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:294
Protected
run Sync
@@ -498,7 +498,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:217
Protected
Abstract
send To Main Worker
@@ -517,7 +517,7 @@ then restore the original execution context.
Returns void
+Defined in src/worker/abstract-worker.ts:185
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:311
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:277
+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 8e355dd5..b4944115 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
Readonly
main Worker
main Worker : 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
Methods
@@ -194,7 +194,7 @@ but the minimum number of workers will be guaranteed.
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:306
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:283
+Defined in src/worker/abstract-worker.ts:192
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:302
+Defined in src/worker/abstract-worker.ts:173
Protected
handle Error
@@ -278,12 +278,12 @@ never be called.
-Returns string Message of the error.
+Returns string The error message.
+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:250
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:294
+Defined in src/worker/abstract-worker.ts:217
Protected
send To Main Worker
+Defined in src/worker/cluster-worker.ts:47
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:311
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:277
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:390
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:652
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:715
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:567
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:661
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:580
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:540
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:422
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:452
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:679
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:695
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:611
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:551
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:535
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:561
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:296
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:268
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:250
Static
once
once ( emitter , eventName , options ? ) : Promise < any [] >
@@ -772,7 +772,7 @@ special handling:
Returns Promise < any [] >
+
Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:190
Static
set Max Listeners
@@ -797,7 +797,7 @@ special handling:
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:311
+Defined in src/queue.ts:58
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:294
+Defined in src/worker/abstract-worker.ts:217
Protected
send To Main Worker
+Defined in src/worker/thread-worker.ts:47
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:311
+Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:277
+Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:153
+Defined in src/pools/pool.ts:124
Optional
worker Choice Strategy Options
@@ -164,7 +164,7 @@
+Defined in src/pools/pool.ts:128
+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:165
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:172
set Options
set Options : ( ( opts ) => void )
@@ -124,7 +124,7 @@
Returns void
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:197
Readonly
strategy Policy
@@ -132,7 +132,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:162
Readonly
task Statistics Requirements
@@ -140,7 +140,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:166
update
update : ( ( workerNodeKey ) => boolean )
@@ -162,7 +162,7 @@
+Defined in src/pools/selection-strategies/selection-strategies-types.ts:178
+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:63
Optional
Readonly
task Performance
@@ -116,7 +116,7 @@
+Defined in src/utility-types.ts:67
Optional
Readonly
timestamp
timestamp ?: number
@@ -125,7 +125,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:96
+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:14
+Defined in src/utility-types.ts:28
+Defined in src/pools/worker.ts:118
Readonly
max Queued
max Queued : number
@@ -71,7 +71,7 @@
+Defined in src/pools/worker.ts:114
Readonly
queued
queued : number
@@ -79,7 +79,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:26
+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:138
The error raised by the worker.