From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Date: Sat, 22 Oct 2022 13:00:23 +0000 (+0000)
Subject: Generate documentation
X-Git-Tag: v2.3.6~3
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=fb61ac734cb4236948a9c7b58fe55d2ca5665ef2;p=poolifier.git
Generate documentation
---
diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html
index ab245720..367685a4 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,13 +136,13 @@ 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
+Defined in src/worker/abstract-worker.ts:49
Readonly
opts
@@ -150,7 +150,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:124
+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:166
+Defined in src/worker/abstract-worker.ts:189
+Defined in src/worker/cluster-worker.ts:42
trigger Async Id
diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html
index c4179afc..d56e2a88 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
@@ -134,7 +134,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
@@ -144,18 +144,18 @@ When the maximum number of workers is reached, an event is emitted. If you want
Inherit Doc
+Defined in src/pools/abstract-pool.ts:40
Readonly
file Path
file Path: string
+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
@@ -163,19 +163,19 @@ 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
+Defined in src/pools/abstract-pool.ts:79
+Defined in src/pools/cluster/fixed.ts:53
Protected
promise Map
promise Map: Map < number , PromiseWorkerResponseWrapper < Worker , Response > > = ...
@@ -188,7 +188,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 >
@@ -197,7 +197,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 [] = []
@@ -205,7 +205,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
Inherit Doc
+Defined in src/pools/abstract-pool.ts:31
Readonly
workers Tasks Usage
workers Tasks Usage: Map < Worker , TasksUsage > = ...
@@ -213,7 +213,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
Inherit Doc
+Defined in src/pools/abstract-pool.ts:34
Accessors
@@ -226,7 +226,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:249
+Defined in src/pools/abstract-pool.ts:287
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:341
+Defined in src/pools/cluster/fixed.ts:88
+Defined in src/pools/abstract-pool.ts:219
+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 Execute
+Defined in src/pools/abstract-pool.ts:312
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:274
+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
@@ -609,7 +609,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:365
+Defined in src/pools/abstract-pool.ts:58
Readonly
number Of Workers
number Of Workers: number
+Defined in src/pools/abstract-pool.ts:79
+Defined in src/pools/abstract-pool.ts:81
Protected
promise Map
@@ -188,7 +188,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
@@ -197,7 +197,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
@@ -205,7 +205,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
Inherit Doc
+Defined in src/pools/abstract-pool.ts:31
Readonly
workers Tasks Usage
@@ -213,7 +213,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
Inherit Doc
+Defined in src/pools/abstract-pool.ts:34
Accessors
@@ -226,7 +226,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:249
+Defined in src/pools/abstract-pool.ts:287
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:341
+Defined in src/pools/thread/fixed.ts:73
+Defined in src/pools/abstract-pool.ts:219
+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 Execute
+Defined in src/pools/abstract-pool.ts:312
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:274
+Defined in src/pools/thread/fixed.ts:57
+Defined in src/pools/abstract-pool.ts:171
+Defined in src/pools/abstract-pool.ts:234
Protected
worker Listener
@@ -610,7 +610,7 @@ to run code before workers are created in the abstract constructor.
Returns void
+Defined in src/pools/abstract-pool.ts:365
+Defined in src/pools/abstract-pool.ts:58
Readonly
number Of Workers
number Of Workers: number
+Defined in src/pools/abstract-pool.ts:79
+Defined in src/pools/cluster/fixed.ts:53
Protected
promise Map
promise Map: Map < number , PromiseWorkerResponseWrapper < Worker , Response > > = ...
@@ -180,7 +180,7 @@
+Defined in src/pools/abstract-pool.ts:50
Protected
worker Choice Strategy Context
worker Choice Strategy Context: WorkerChoiceStrategyContext < Worker , Data , Response >
@@ -189,7 +189,7 @@
+Defined in src/pools/abstract-pool.ts:65
Readonly
workers
workers: Worker [] = []
@@ -197,7 +197,7 @@
Inherit Doc
+Defined in src/pools/abstract-pool.ts:31
Readonly
workers Tasks Usage
workers Tasks Usage: Map < Worker , TasksUsage > = ...
@@ -205,7 +205,7 @@
Inherit Doc
+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:249
+Defined in src/pools/abstract-pool.ts:287
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:341
+Defined in src/pools/cluster/fixed.ts:88
+Defined in src/pools/abstract-pool.ts:219
+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 Execute
+Defined in src/pools/abstract-pool.ts:312
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:274
+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
@@ -601,7 +601,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:365
+Defined in src/pools/abstract-pool.ts:58
Readonly
number Of Workers
number Of Workers: number
+Defined in src/pools/abstract-pool.ts:79
+Defined in src/pools/abstract-pool.ts:81
Protected
promise Map
@@ -180,7 +180,7 @@
+Defined in src/pools/abstract-pool.ts:50
Protected
worker Choice Strategy Context
@@ -189,7 +189,7 @@
+Defined in src/pools/abstract-pool.ts:65
Readonly
workers
@@ -197,7 +197,7 @@
Inherit Doc
+Defined in src/pools/abstract-pool.ts:31
Readonly
workers Tasks Usage
@@ -205,7 +205,7 @@
Inherit Doc
+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:249
+Defined in src/pools/abstract-pool.ts:287
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:341
+Defined in src/pools/thread/fixed.ts:73
+Defined in src/pools/abstract-pool.ts:219
+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 Execute
+Defined in src/pools/abstract-pool.ts:312
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:274
+Defined in src/pools/thread/fixed.ts:57
+Defined in src/pools/abstract-pool.ts:171
+Defined in src/pools/abstract-pool.ts:234
Protected
worker Listener
@@ -602,7 +602,7 @@ to run code before workers are created in the abstract constructor.
Returns void
+Defined in src/pools/abstract-pool.ts:365
+Defined in src/worker/abstract-worker.ts:27
Protected
main Worker
main Worker: undefined | null | MessagePort
+Defined in src/worker/abstract-worker.ts:49
Readonly
opts
@@ -150,7 +150,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:124
+Defined in src/worker/abstract-worker.ts:156
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:81
+Defined in src/worker/abstract-worker.ts:166
+Defined in src/worker/abstract-worker.ts:189
+Defined in src/worker/thread-worker.ts:36
trigger Async Id
diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html
index f1ecc7e1..825f9e0c 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
Returns Promise < void >
+Defined in src/pools/pool.ts:72
execute
Returns Promise < Response >
+Defined in src/pools/pool.ts:68
set Worker Choice Strategy
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 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 function that will listen for error event on each worker.