From a75da00c7b8dbbb148d2cf2472ce73e4201d9a4a Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Tue, 4 Apr 2023 17:11:28 +0000
Subject: [PATCH] chore: generate documentation
---
docs/classes/ClusterWorker.html | 26 ++++----
docs/classes/DynamicClusterPool.html | 62 +++++++++----------
docs/classes/DynamicThreadPool.html | 62 +++++++++----------
docs/classes/FixedClusterPool.html | 60 +++++++++---------
docs/classes/FixedThreadPool.html | 60 +++++++++---------
docs/classes/PoolEmitter.html | 2 +-
docs/classes/ThreadWorker.html | 26 ++++----
docs/interfaces/ClusterPoolOptions.html | 18 +++---
docs/interfaces/IPool.html | 10 +--
docs/interfaces/PoolOptions.html | 14 ++---
docs/interfaces/WorkerOptions.html | 8 +--
docs/types/ErrorHandler.html | 2 +-
docs/types/ExitHandler.html | 2 +-
docs/types/KillBehavior.html | 2 +-
docs/types/MessageHandler.html | 2 +-
docs/types/OnlineHandler.html | 2 +-
.../types/ThreadWorkerWithMessageChannel.html | 2 +-
docs/types/WorkerChoiceStrategy.html | 2 +-
docs/variables/KillBehaviors.html | 2 +-
docs/variables/WorkerChoiceStrategies.html | 2 +-
20 files changed, 183 insertions(+), 183 deletions(-)
diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html
index cd69cbcd..8c9f948a 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:31
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:53
Readonly
opts
@@ -152,7 +152,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:39
+Defined in src/worker/abstract-worker.ts:130
+Defined in src/worker/cluster-worker.ts:47
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:84
+Defined in src/worker/abstract-worker.ts:172
+Defined in src/worker/abstract-worker.ts:196
+Defined in src/worker/cluster-worker.ts:42
trigger Async Id
diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html
index 81741061..77cdcd29 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
@@ -128,7 +128,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
@@ -138,7 +138,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:32
Readonly
file Path
file Path: string
@@ -146,14 +146,14 @@ When the maximum number of workers is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:67
Protected
Readonly
max
max: number
+Defined in src/pools/cluster/dynamic.ts:30
Readonly
number Of Workers
number Of Workers: number
@@ -161,7 +161,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
@@ -169,7 +169,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 > > = ...
@@ -182,7 +182,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 >
@@ -191,7 +191,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 > [] = []
@@ -199,7 +199,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
@@ -212,7 +212,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:141
+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:241
+Defined in src/pools/abstract-pool.ts:292
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:207
+Defined in src/pools/cluster/fixed.ts:69
+Defined in src/pools/abstract-pool.ts:192
+Defined in src/pools/abstract-pool.ts:185
Protected
internal Get Busy Status
+Defined in src/pools/abstract-pool.ts:177
+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:279
+Defined in src/pools/cluster/fixed.ts:75
+Defined in src/pools/abstract-pool.ts:156
+Defined in src/pools/cluster/fixed.ts:59
Protected
worker Listener
@@ -531,7 +531,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:366
+Defined in src/pools/abstract-pool.ts:67
Protected
Readonly
max
max: number
+Defined in src/pools/thread/dynamic.ts:31
Readonly
number Of Workers
number Of Workers: number
@@ -161,7 +161,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
+Defined in src/pools/abstract-pool.ts:66
Readonly
opts
@@ -169,7 +169,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
@@ -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:42
Protected
worker Choice Strategy Context
@@ -191,7 +191,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
@@ -199,7 +199,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
@@ -212,7 +212,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:141
+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:241
+Defined in src/pools/abstract-pool.ts:292
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:337
+Defined in src/pools/thread/fixed.ts:78
+Defined in src/pools/abstract-pool.ts:207
+Defined in src/pools/thread/fixed.ts:54
+Defined in src/pools/abstract-pool.ts:192
+Defined in src/pools/abstract-pool.ts:185
Protected
internal Get Busy Status
+Defined in src/pools/abstract-pool.ts:177
+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:279
+Defined in src/pools/thread/fixed.ts:62
+Defined in src/pools/abstract-pool.ts:156
+Defined in src/pools/abstract-pool.ts:226
Protected
worker Listener
@@ -532,7 +532,7 @@ to run code before workers are created in the abstract constructor.
Returns void
+Defined in src/pools/abstract-pool.ts:366
+Defined in src/pools/abstract-pool.ts:67
Readonly
number Of Workers
number Of Workers: number
@@ -151,7 +151,7 @@
+Defined in src/pools/abstract-pool.ts:66
Readonly
opts
@@ -159,7 +159,7 @@
+Defined in src/pools/cluster/fixed.ts:53
Protected
promise Response Map
promise Response Map: Map < string , PromiseResponseWrapper < Worker , Response > > = ...
@@ -172,7 +172,7 @@
+Defined in src/pools/abstract-pool.ts:42
Protected
worker Choice Strategy Context
worker Choice Strategy Context: WorkerChoiceStrategyContext < Worker , Data , Response >
@@ -181,7 +181,7 @@
+Defined in src/pools/abstract-pool.ts:52
Readonly
workers
workers: WorkerType < Worker > [] = []
@@ -189,7 +189,7 @@
+Defined in src/pools/abstract-pool.ts:29
+Defined in src/pools/abstract-pool.ts:141
+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:241
+Defined in src/pools/abstract-pool.ts:292
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:207
+Defined in src/pools/cluster/fixed.ts:69
+Defined in src/pools/abstract-pool.ts:192
+Defined in src/pools/abstract-pool.ts:185
Protected
internal Get Busy Status
+Defined in src/pools/abstract-pool.ts:177
+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:279
+Defined in src/pools/cluster/fixed.ts:75
+Defined in src/pools/abstract-pool.ts:156
+Defined in src/pools/cluster/fixed.ts:59
Protected
worker Listener
@@ -521,7 +521,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:366
+Defined in src/pools/abstract-pool.ts:67
Readonly
number Of Workers
number Of Workers: number
@@ -151,7 +151,7 @@
+Defined in src/pools/abstract-pool.ts:66
Readonly
opts
@@ -159,7 +159,7 @@
+Defined in src/pools/abstract-pool.ts:68
Protected
promise Response Map
@@ -172,7 +172,7 @@
+Defined in src/pools/abstract-pool.ts:42
Protected
worker Choice Strategy Context
@@ -181,7 +181,7 @@
+Defined in src/pools/abstract-pool.ts:52
Readonly
workers
@@ -189,7 +189,7 @@
+Defined in src/pools/abstract-pool.ts:29
+Defined in src/pools/abstract-pool.ts:141
+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:241
+Defined in src/pools/abstract-pool.ts:292
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:337
+Defined in src/pools/thread/fixed.ts:78
+Defined in src/pools/abstract-pool.ts:207
+Defined in src/pools/thread/fixed.ts:54
+Defined in src/pools/abstract-pool.ts:192
+Defined in src/pools/abstract-pool.ts:185
Protected
internal Get Busy Status
+Defined in src/pools/abstract-pool.ts:177
+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:279
+Defined in src/pools/thread/fixed.ts:62
+Defined in src/pools/abstract-pool.ts:156
+Defined in src/pools/abstract-pool.ts:226
Protected
worker Listener
@@ -522,7 +522,7 @@ to run code before workers are created in the abstract constructor.
Returns void
+Defined in src/pools/abstract-pool.ts:366
+Defined in src/worker/abstract-worker.ts:31
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:53
Readonly
opts
@@ -152,7 +152,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:39
+Defined in src/worker/abstract-worker.ts:130
+Defined in src/worker/abstract-worker.ts:162
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:84
+Defined in src/worker/abstract-worker.ts:172
+Defined in src/worker/abstract-worker.ts:196
+Defined in src/worker/thread-worker.ts:36
trigger Async Id
diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html
index 23e1bad7..6cce306d 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
Maximum number of workers that can be created by this pool.