From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Date: Wed, 5 Apr 2023 11:34:34 +0000 (+0000)
Subject: chore: generate documentation
X-Git-Tag: v2.4.1~3
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=ba92b02f642f229cb927ab526148f10107831471;p=poolifier.git
chore: generate documentation
---
diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html
index 4fec31f3..efddf4c5 100644
--- a/docs/classes/ClusterWorker.html
+++ b/docs/classes/ClusterWorker.html
@@ -44,7 +44,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/cluster-worker.ts:21
@@ -119,7 +119,7 @@ but the minimum number of workers will be guaranteed.
Overrides AbstractWorker<Worker, Data, Response>.constructor
+Defined in src/worker/cluster-worker.ts:31
Protected
Readonly
is Main
is Main: boolean
@@ -137,7 +137,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:47
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:27
Protected
main Worker
main Worker: undefined | null | Worker
@@ -153,7 +153,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:49
Readonly
opts
@@ -161,7 +161,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:35
+Defined in src/worker/abstract-worker.ts:126
+Defined in src/worker/cluster-worker.ts:47
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:80
+Defined in src/worker/abstract-worker.ts:168
+Defined in src/worker/abstract-worker.ts:191
+Defined in src/worker/cluster-worker.ts:42
trigger Async Id
diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html
index 583cf496..f02a5d7a 100644
--- a/docs/classes/DynamicClusterPool.html
+++ b/docs/classes/DynamicClusterPool.html
@@ -18,7 +18,7 @@
+Defined in src/pools/abstract-pool.ts:32
Readonly
file Path
file Path: string
@@ -147,14 +147,14 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:67
Private
Readonly
max
max: number
+Defined in src/pools/cluster/dynamic.ts:30
Readonly
number Of Workers
number Of Workers: number
@@ -162,7 +162,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:66
Readonly
opts
@@ -170,7 +170,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/cluster/fixed.ts:53
Protected
promise Response Map
promise Response Map: Map < string , PromiseResponseWrapper < Worker , Response > > = ...
@@ -183,7 +183,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:42
Protected
worker Choice Strategy Context
worker Choice Strategy Context: WorkerChoiceStrategyContext < Worker , Data , Response >
@@ -192,7 +192,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:52
Readonly
workers
workers: WorkerType < Worker > [] = []
@@ -200,7 +200,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:29
Accessors
@@ -213,7 +213,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
Returns boolean
+Defined in src/pools/cluster/dynamic.ts:48
+Defined in src/pools/cluster/dynamic.ts:43
Private
number Of Running Tasks
+Defined in src/pools/abstract-pool.ts:153
+Defined in src/pools/cluster/dynamic.ts:38
Protected
after Worker Setup
+Defined in src/pools/cluster/fixed.ts:93
Protected
before Promise Response Hook
+Defined in src/pools/abstract-pool.ts:256
+Defined in src/pools/abstract-pool.ts:307
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:352
+Defined in src/pools/cluster/fixed.ts:88
+Defined in src/pools/abstract-pool.ts:222
+Defined in src/pools/cluster/fixed.ts:69
+Defined in src/pools/abstract-pool.ts:207
+Defined in src/pools/abstract-pool.ts:200
+Defined in src/pools/abstract-pool.ts:192
+Defined in src/pools/cluster/fixed.ts:64
register Worker Message Listener
+Defined in src/pools/cluster/fixed.ts:80
+Defined in src/pools/abstract-pool.ts:294
+Defined in src/pools/cluster/fixed.ts:75
+Defined in src/pools/abstract-pool.ts:168
+Defined in src/pools/cluster/fixed.ts:59
Protected
worker Listener
@@ -543,7 +543,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:381
+Defined in src/pools/abstract-pool.ts:66
Readonly
opts
@@ -170,7 +170,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:68
Protected
promise Response Map
@@ -183,7 +183,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:42
Protected
worker Choice Strategy Context
@@ -192,7 +192,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:52
Readonly
workers
@@ -200,7 +200,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:29
Accessors
@@ -213,7 +213,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
Returns boolean
+Defined in src/pools/thread/dynamic.ts:49
+Defined in src/pools/thread/dynamic.ts:44
Private
number Of Running Tasks
+Defined in src/pools/abstract-pool.ts:153
+Defined in src/pools/thread/dynamic.ts:39
Protected
after Worker Setup
+Defined in src/pools/thread/fixed.ts:85
Protected
before Promise Response Hook
+Defined in src/pools/abstract-pool.ts:256
+Defined in src/pools/abstract-pool.ts:307
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:352
+Defined in src/pools/thread/fixed.ts:78
+Defined in src/pools/abstract-pool.ts:222
+Defined in src/pools/thread/fixed.ts:54
+Defined in src/pools/abstract-pool.ts:207
+Defined in src/pools/abstract-pool.ts:200
+Defined in src/pools/abstract-pool.ts:192
+Defined in src/pools/thread/fixed.ts:49
register Worker Message Listener
+Defined in src/pools/thread/fixed.ts:70
+Defined in src/pools/abstract-pool.ts:294
+Defined in src/pools/thread/fixed.ts:62
+Defined in src/pools/abstract-pool.ts:168
+Defined in src/pools/abstract-pool.ts:241
Protected
worker Listener
@@ -544,7 +544,7 @@ to run code before workers are created in the abstract constructor.
Returns void
+Defined in src/pools/abstract-pool.ts:381
+Defined in src/pools/abstract-pool.ts:67
Readonly
number Of Workers
number Of Workers: number
@@ -152,7 +152,7 @@
+Defined in src/pools/abstract-pool.ts:66
Readonly
opts
@@ -160,7 +160,7 @@
+Defined in src/pools/cluster/fixed.ts:53
Protected
promise Response Map
promise Response Map: Map < string , PromiseResponseWrapper < Worker , Response > > = ...
@@ -173,7 +173,7 @@
+Defined in src/pools/abstract-pool.ts:42
Protected
worker Choice Strategy Context
worker Choice Strategy Context: WorkerChoiceStrategyContext < Worker , Data , Response >
@@ -182,7 +182,7 @@
+Defined in src/pools/abstract-pool.ts:52
Readonly
workers
workers: WorkerType < Worker > [] = []
@@ -190,7 +190,7 @@
+Defined in src/pools/abstract-pool.ts:29
+Defined in src/pools/cluster/fixed.ts:104
Private
number Of Running Tasks
+Defined in src/pools/abstract-pool.ts:153
+Defined in src/pools/cluster/fixed.ts:99
Protected
after Worker Setup
+Defined in src/pools/cluster/fixed.ts:93
Protected
before Promise Response Hook
+Defined in src/pools/abstract-pool.ts:256
+Defined in src/pools/abstract-pool.ts:307
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:352
+Defined in src/pools/cluster/fixed.ts:88
+Defined in src/pools/abstract-pool.ts:222
+Defined in src/pools/cluster/fixed.ts:69
+Defined in src/pools/abstract-pool.ts:207
+Defined in src/pools/abstract-pool.ts:200
+Defined in src/pools/abstract-pool.ts:192
+Defined in src/pools/cluster/fixed.ts:64
register Worker Message Listener
+Defined in src/pools/cluster/fixed.ts:80
+Defined in src/pools/abstract-pool.ts:294
+Defined in src/pools/cluster/fixed.ts:75
+Defined in src/pools/abstract-pool.ts:168
+Defined in src/pools/cluster/fixed.ts:59
Protected
worker Listener
@@ -533,7 +533,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:381
+Defined in src/pools/abstract-pool.ts:67
Readonly
number Of Workers
number Of Workers: number
@@ -152,7 +152,7 @@
+Defined in src/pools/abstract-pool.ts:66
Readonly
opts
@@ -160,7 +160,7 @@
+Defined in src/pools/abstract-pool.ts:68
Protected
promise Response Map
@@ -173,7 +173,7 @@
+Defined in src/pools/abstract-pool.ts:42
Protected
worker Choice Strategy Context
@@ -182,7 +182,7 @@
+Defined in src/pools/abstract-pool.ts:52
Readonly
workers
@@ -190,7 +190,7 @@
+Defined in src/pools/abstract-pool.ts:29
+Defined in src/pools/thread/fixed.ts:100
Private
number Of Running Tasks
+Defined in src/pools/abstract-pool.ts:153
+Defined in src/pools/thread/fixed.ts:95
Protected
after Worker Setup
+Defined in src/pools/thread/fixed.ts:85
Protected
before Promise Response Hook
+Defined in src/pools/abstract-pool.ts:256
+Defined in src/pools/abstract-pool.ts:307
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:352
+Defined in src/pools/thread/fixed.ts:78
+Defined in src/pools/abstract-pool.ts:222
+Defined in src/pools/thread/fixed.ts:54
+Defined in src/pools/abstract-pool.ts:207
+Defined in src/pools/abstract-pool.ts:200
+Defined in src/pools/abstract-pool.ts:192
+Defined in src/pools/thread/fixed.ts:49
register Worker Message Listener
+Defined in src/pools/thread/fixed.ts:70
+Defined in src/pools/abstract-pool.ts:294
+Defined in src/pools/thread/fixed.ts:62
+Defined in src/pools/abstract-pool.ts:168
+Defined in src/pools/abstract-pool.ts:241
Protected
worker Listener
@@ -534,7 +534,7 @@ to run code before workers are created in the abstract constructor.
Returns void
+Defined in src/pools/abstract-pool.ts:381
+Defined in src/worker/abstract-worker.ts:47
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:27
Protected
main Worker
main Worker: undefined | null | MessagePort
@@ -153,7 +153,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:49
Readonly
opts
@@ -161,7 +161,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:35
+Defined in src/worker/abstract-worker.ts:126
+Defined in src/worker/abstract-worker.ts:158
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:80
+Defined in src/worker/abstract-worker.ts:168
+Defined in src/worker/abstract-worker.ts:191
+Defined in src/worker/thread-worker.ts:36
trigger Async Id
diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html
index 270c0ec4..cd8711f9 100644
--- a/docs/interfaces/ClusterPoolOptions.html
+++ b/docs/interfaces/ClusterPoolOptions.html
@@ -25,7 +25,7 @@
+Defined in src/pools/cluster/fixed.ts:11
+Defined in src/pools/cluster/fixed.ts:18
Optional
error Handler
@@ -70,7 +70,7 @@
+Defined in src/pools/pool.ts:26
Optional
exit Handler
@@ -78,7 +78,7 @@
+Defined in src/pools/pool.ts:34
Optional
message Handler
@@ -86,7 +86,7 @@
+Defined in src/pools/pool.ts:22
Optional
online Handler
@@ -94,7 +94,7 @@
+Defined in src/pools/pool.ts:30
+Defined in src/pools/cluster/fixed.ts:24
Optional
worker Choice Strategy
worker Choice Strategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
@@ -111,7 +111,7 @@
+Defined in src/pools/pool.ts:38
+Defined in src/pools/pool.ts:72
Optional
Readonly
emitter
@@ -74,7 +74,7 @@
+Defined in src/pools/pool.ts:61
execute
execute: ( ( data: Data ) => Promise < Response > )
@@ -98,7 +98,7 @@
Returns Promise < Response >
+Defined in src/pools/pool.ts:68
set Worker Choice Strategy
set Worker Choice Strategy: ( ( workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" ) => void )
@@ -120,7 +120,7 @@
Returns void
+Defined in src/pools/pool.ts:78
+Defined in src/pools/pool.ts:38
+Defined in src/worker/worker-options.ts:68
Optional
max Inactive Time
max Inactive Time?: number
@@ -75,7 +75,7 @@ when this timeout expires your tasks is interrupted and the worker is killed if
Default Value 60000 ms
+Defined in src/worker/worker-options.ts:51
+Defined in src/pools/pool-worker.ts:9
+Defined in src/pools/pool-worker.ts:19
+Defined in src/pools/pool-worker.ts:4
+Defined in src/pools/pool-worker.ts:14
A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
This cluster pool creates new workers when the others are busy, up to the maximum number of workers. -When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's
+When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool'semitter
.emitter
.Author
Christopher Quadflieg
@@ -42,7 +42,7 @@ When the maximum number of workers is reached, an event is emitted. If you want@@ -129,7 +129,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
Returns DynamicClusterPool<Data, Response>
Properties