From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Date: Sat, 18 Mar 2023 19:39:22 +0000 (+0000)
Subject: chore: generate documentation
X-Git-Tag: v2.4.0-0~50^2
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=f06d10306cf1bfffb90048cf6e96c8507cd0e916;p=poolifier.git
chore: generate documentation
---
diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html
index cdfaa2f0..0a6c47d8 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
@@ -118,7 +118,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
last Task Timestamp
last Task Timestamp: number
@@ -136,7 +136,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
@@ -144,7 +144,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:49
Readonly
opts
@@ -152,7 +152,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:127
+Defined in src/worker/cluster-worker.ts:47
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:81
+Defined in src/worker/abstract-worker.ts:169
+Defined in src/worker/abstract-worker.ts:192
+Defined in src/worker/cluster-worker.ts:42
trigger Async Id
diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html
index de57c480..377ee16b 100644
--- a/docs/classes/DynamicClusterPool.html
+++ b/docs/classes/DynamicClusterPool.html
@@ -42,7 +42,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/cluster/dynamic.ts:16
@@ -133,7 +133,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/cluster/dynamic.ts:28
Properties
@@ -143,7 +143,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:40
Readonly
file Path
file Path: string
@@ -151,14 +151,14 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:80
Protected
Readonly
max
max: number
+Defined in src/pools/cluster/dynamic.ts:30
Protected
next Message Id
next Message Id: number = 0
@@ -166,7 +166,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:58
Readonly
number Of Workers
number Of Workers: number
@@ -174,7 +174,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:79
Readonly
opts
@@ -182,7 +182,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 Map
promise Map: Map < number , PromiseWorkerResponseWrapper < Worker , Response > > = ...
@@ -195,7 +195,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:50
Protected
worker Choice Strategy Context
worker Choice Strategy Context: WorkerChoiceStrategyContext < Worker , Data , Response >
@@ -204,7 +204,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:65
Readonly
workers
workers: Worker [] = []
@@ -212,7 +212,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:31
Readonly
workers Tasks Usage
workers Tasks Usage: Map < Worker , TasksUsage > = ...
@@ -220,7 +220,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:34
Accessors
@@ -233,7 +233,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:43
+Defined in src/pools/abstract-pool.ts:151
+Defined in src/pools/cluster/dynamic.ts:38
Protected
after Worker Setup
+Defined in src/pools/cluster/fixed.ts:93
Protected
before Promise Worker Response Hook
+Defined in src/pools/abstract-pool.ts:255
+Defined in src/pools/abstract-pool.ts:293
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:337
+Defined in src/pools/cluster/fixed.ts:88
+Defined in src/pools/abstract-pool.ts:221
+Defined in src/pools/cluster/fixed.ts:69
+Defined in src/pools/abstract-pool.ts:205
+Defined in src/pools/abstract-pool.ts:194
get Worker Average Tasks Run Time
+Defined in src/pools/abstract-pool.ts:166
+Defined in src/pools/abstract-pool.ts:156
+Defined in src/pools/abstract-pool.ts:161
Protected
internal Get Busy Status
+Defined in src/pools/abstract-pool.ts:186
+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:280
+Defined in src/pools/cluster/fixed.ts:75
+Defined in src/pools/abstract-pool.ts:171
+Defined in src/pools/cluster/fixed.ts:59
Protected
worker Listener
@@ -600,7 +600,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:363
+Defined in src/pools/abstract-pool.ts:80
Protected
Readonly
max
max: number
+Defined in src/pools/thread/dynamic.ts:31
Protected
next Message Id
next Message Id: number = 0
@@ -166,7 +166,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:58
Readonly
number Of Workers
number Of Workers: number
@@ -174,7 +174,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:79
Readonly
opts
@@ -182,7 +182,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:81
Protected
promise Map
@@ -195,7 +195,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:50
Protected
worker Choice Strategy Context
@@ -204,7 +204,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:65
Readonly
workers
@@ -212,7 +212,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:31
Readonly
workers Tasks Usage
@@ -220,7 +220,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:34
Accessors
@@ -233,7 +233,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:44
+Defined in src/pools/abstract-pool.ts:151
+Defined in src/pools/thread/dynamic.ts:39
Protected
after Worker Setup
+Defined in src/pools/thread/fixed.ts:80
Protected
before Promise Worker Response Hook
+Defined in src/pools/abstract-pool.ts:255
+Defined in src/pools/abstract-pool.ts:293
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:337
+Defined in src/pools/thread/fixed.ts:73
+Defined in src/pools/abstract-pool.ts:221
+Defined in src/pools/thread/fixed.ts:49
+Defined in src/pools/abstract-pool.ts:205
+Defined in src/pools/abstract-pool.ts:194
get Worker Average Tasks Run Time
+Defined in src/pools/abstract-pool.ts:166
+Defined in src/pools/abstract-pool.ts:156
+Defined in src/pools/abstract-pool.ts:161
Protected
internal Get Busy Status
+Defined in src/pools/abstract-pool.ts:186
+Defined in src/pools/thread/fixed.ts:44
register Worker Message Listener
+Defined in src/pools/thread/fixed.ts:65
+Defined in src/pools/abstract-pool.ts:280
+Defined in src/pools/thread/fixed.ts:57
+Defined in src/pools/abstract-pool.ts:171
+Defined in src/pools/abstract-pool.ts:240
Protected
worker Listener
@@ -601,7 +601,7 @@ to run code before workers are created in the abstract constructor.
Returns void
+Defined in src/pools/abstract-pool.ts:363
+Defined in src/pools/abstract-pool.ts:80
Protected
next Message Id
next Message Id: number = 0
@@ -156,7 +156,7 @@
+Defined in src/pools/abstract-pool.ts:58
Readonly
number Of Workers
number Of Workers: number
@@ -164,7 +164,7 @@
+Defined in src/pools/abstract-pool.ts:79
Readonly
opts
@@ -172,7 +172,7 @@
+Defined in src/pools/cluster/fixed.ts:53
Protected
promise Map
promise Map: Map < number , PromiseWorkerResponseWrapper < Worker , Response > > = ...
@@ -185,7 +185,7 @@
+Defined in src/pools/abstract-pool.ts:50
Protected
worker Choice Strategy Context
worker Choice Strategy Context: WorkerChoiceStrategyContext < Worker , Data , Response >
@@ -194,7 +194,7 @@
+Defined in src/pools/abstract-pool.ts:65
Readonly
workers
workers: Worker [] = []
@@ -202,7 +202,7 @@
+Defined in src/pools/abstract-pool.ts:31
Readonly
workers Tasks Usage
workers Tasks Usage: Map < Worker , TasksUsage > = ...
@@ -210,7 +210,7 @@
+Defined in src/pools/abstract-pool.ts:34
+Defined in src/pools/abstract-pool.ts:151
+Defined in src/pools/cluster/fixed.ts:99
Protected
after Worker Setup
+Defined in src/pools/cluster/fixed.ts:93
Protected
before Promise Worker Response Hook
+Defined in src/pools/abstract-pool.ts:255
+Defined in src/pools/abstract-pool.ts:293
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:337
+Defined in src/pools/cluster/fixed.ts:88
+Defined in src/pools/abstract-pool.ts:221
+Defined in src/pools/cluster/fixed.ts:69
+Defined in src/pools/abstract-pool.ts:205
+Defined in src/pools/abstract-pool.ts:194
get Worker Average Tasks Run Time
+Defined in src/pools/abstract-pool.ts:166
+Defined in src/pools/abstract-pool.ts:156
+Defined in src/pools/abstract-pool.ts:161
Protected
internal Get Busy Status
+Defined in src/pools/abstract-pool.ts:186
+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:280
+Defined in src/pools/cluster/fixed.ts:75
+Defined in src/pools/abstract-pool.ts:171
+Defined in src/pools/cluster/fixed.ts:59
Protected
worker Listener
@@ -590,7 +590,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:363
+Defined in src/pools/abstract-pool.ts:80
Protected
next Message Id
next Message Id: number = 0
@@ -156,7 +156,7 @@
+Defined in src/pools/abstract-pool.ts:58
Readonly
number Of Workers
number Of Workers: number
@@ -164,7 +164,7 @@
+Defined in src/pools/abstract-pool.ts:79
Readonly
opts
@@ -172,7 +172,7 @@
+Defined in src/pools/abstract-pool.ts:81
Protected
promise Map
@@ -185,7 +185,7 @@
+Defined in src/pools/abstract-pool.ts:50
Protected
worker Choice Strategy Context
@@ -194,7 +194,7 @@
+Defined in src/pools/abstract-pool.ts:65
Readonly
workers
@@ -202,7 +202,7 @@
+Defined in src/pools/abstract-pool.ts:31
Readonly
workers Tasks Usage
@@ -210,7 +210,7 @@
+Defined in src/pools/abstract-pool.ts:34
+Defined in src/pools/abstract-pool.ts:151
+Defined in src/pools/thread/fixed.ts:90
Protected
after Worker Setup
+Defined in src/pools/thread/fixed.ts:80
Protected
before Promise Worker Response Hook
+Defined in src/pools/abstract-pool.ts:255
+Defined in src/pools/abstract-pool.ts:293
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:337
+Defined in src/pools/thread/fixed.ts:73
+Defined in src/pools/abstract-pool.ts:221
+Defined in src/pools/thread/fixed.ts:49
+Defined in src/pools/abstract-pool.ts:205
+Defined in src/pools/abstract-pool.ts:194
get Worker Average Tasks Run Time
+Defined in src/pools/abstract-pool.ts:166
+Defined in src/pools/abstract-pool.ts:156
+Defined in src/pools/abstract-pool.ts:161
Protected
internal Get Busy Status
+Defined in src/pools/abstract-pool.ts:186
+Defined in src/pools/thread/fixed.ts:44
register Worker Message Listener
+Defined in src/pools/thread/fixed.ts:65
+Defined in src/pools/abstract-pool.ts:280
+Defined in src/pools/thread/fixed.ts:57
+Defined in src/pools/abstract-pool.ts:171
+Defined in src/pools/abstract-pool.ts:240
Protected
worker Listener
@@ -591,7 +591,7 @@ to run code before workers are created in the abstract constructor.
Returns void
+Defined in src/pools/abstract-pool.ts:363
+Defined in src/worker/abstract-worker.ts:27
Protected
main Worker
main Worker: undefined | null | MessagePort
@@ -144,7 +144,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:49
Readonly
opts
@@ -152,7 +152,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:127
+Defined in src/worker/abstract-worker.ts:159
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:81
+Defined in src/worker/abstract-worker.ts:169
+Defined in src/worker/abstract-worker.ts:192
+Defined in src/worker/thread-worker.ts:36
trigger Async Id
diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html
index 79ebd263..97f4a545 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_RECENTLY_USED" | "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_RECENTLY_USED" | "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
Maximum number of workers that can be created by this pool.