From b10bb04924a5918496ff64a62ae71b9f99239b28 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Sun, 9 Apr 2023 11:44:55 +0000
Subject: [PATCH] chore: generate documentation
---
docs/classes/ClusterWorker.html | 28 +++----
docs/classes/DynamicClusterPool.html | 76 +++++++++----------
docs/classes/DynamicThreadPool.html | 76 +++++++++----------
docs/classes/FixedClusterPool.html | 74 +++++++++---------
docs/classes/FixedThreadPool.html | 74 +++++++++---------
docs/classes/PoolEmitter.html | 2 +-
docs/classes/ThreadWorker.html | 28 +++----
docs/interfaces/ClusterPoolOptions.html | 22 +++---
docs/interfaces/IPool.html | 10 +--
docs/interfaces/PoolOptions.html | 18 ++---
.../WorkerChoiceStrategyOptions.html | 8 +-
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 +-
docs/types/PoolEvent.html | 2 +-
.../types/ThreadWorkerWithMessageChannel.html | 2 +-
docs/types/WorkerChoiceStrategy.html | 2 +-
docs/variables/KillBehaviors.html | 2 +-
docs/variables/PoolEvents.html | 2 +-
docs/variables/WorkerChoiceStrategies.html | 2 +-
23 files changed, 224 insertions(+), 222 deletions(-)
diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html
index 3aef097c..72d07e7c 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:43
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:45
Protected
Readonly
opts
@@ -161,7 +161,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:46
+Defined in src/worker/abstract-worker.ts:129
+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:171
+Defined in src/worker/abstract-worker.ts:198
+Defined in src/worker/cluster-worker.ts:42
trigger Async Id
diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html
index d12c5c0e..f6c8e289 100644
--- a/docs/classes/DynamicClusterPool.html
+++ b/docs/classes/DynamicClusterPool.html
@@ -42,7 +42,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/cluster/dynamic.ts:16
@@ -135,7 +135,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/cluster/dynamic.ts:28
Properties
@@ -145,7 +145,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Inherit Doc
+Defined in src/pools/abstract-pool.ts:33
Readonly
file Path
file Path: string
@@ -153,14 +153,14 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:68
+Defined in src/pools/cluster/dynamic.ts:30
Readonly
number Of Workers
number Of Workers: number
@@ -168,7 +168,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:67
Readonly
opts
@@ -176,7 +176,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/cluster/fixed.ts:53
Protected
promise Response Map
promise Response Map: Map < string , PromiseResponseWrapper < Worker , Response > > = ...
@@ -189,7 +189,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:43
Protected
worker Choice Strategy Context
worker Choice Strategy Context: WorkerChoiceStrategyContext < Worker , Data , Response >
@@ -198,7 +198,7 @@ When the maximum number of workers is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:53
Readonly
worker Nodes
worker Nodes: WorkerNode < Worker , Data > [] = []
@@ -206,7 +206,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Inherit Doc
+Defined in src/pools/abstract-pool.ts:30
Accessors
@@ -219,7 +219,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Returns boolean
+Defined in src/pools/cluster/dynamic.ts:48
+Defined in src/pools/cluster/dynamic.ts:43
Private
number Of Queued Tasks
+Defined in src/pools/abstract-pool.ts:166
Private
number Of Running Tasks
+Defined in src/pools/abstract-pool.ts:156
+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:296
Protected
choose Worker Node
+Defined in src/pools/abstract-pool.ts:340
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:406
+Defined in src/pools/cluster/fixed.ts:88
+Defined in src/pools/abstract-pool.ts:555
+Defined in src/pools/abstract-pool.ts:259
+Defined in src/pools/cluster/fixed.ts:69
+Defined in src/pools/abstract-pool.ts:551
+Defined in src/pools/abstract-pool.ts:236
+Defined in src/pools/abstract-pool.ts:229
Protected
flush Tasks Queue
+Defined in src/pools/abstract-pool.ts:563
Protected
flush Tasks Queue By Worker
+Defined in src/pools/abstract-pool.ts:572
+Defined in src/pools/abstract-pool.ts:221
+Defined in src/pools/cluster/fixed.ts:64
register Worker Message Listener
+Defined in src/pools/cluster/fixed.ts:80
Protected
remove Worker Node
+Defined in src/pools/abstract-pool.ts:545
+Defined in src/pools/cluster/fixed.ts:75
+Defined in src/pools/abstract-pool.ts:189
+Defined in src/pools/cluster/fixed.ts:59
Protected
tasks Queue Length
+Defined in src/pools/abstract-pool.ts:559
Protected
worker Listener
@@ -632,7 +632,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:429
+Defined in src/pools/abstract-pool.ts:68
+Defined in src/pools/thread/dynamic.ts:31
Readonly
number Of Workers
number Of Workers: number
@@ -168,7 +168,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:67
Readonly
opts
@@ -176,7 +176,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:69
Protected
promise Response Map
@@ -189,7 +189,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:43
Protected
worker Choice Strategy Context
@@ -198,7 +198,7 @@ When the maximum number of threads is reached and workers are busy, an event is
+Defined in src/pools/abstract-pool.ts:53
Readonly
worker Nodes
@@ -206,7 +206,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Inherit Doc
+Defined in src/pools/abstract-pool.ts:30
Accessors
@@ -219,7 +219,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Returns boolean
+Defined in src/pools/thread/dynamic.ts:49
+Defined in src/pools/thread/dynamic.ts:44
Private
number Of Queued Tasks
+Defined in src/pools/abstract-pool.ts:166
Private
number Of Running Tasks
+Defined in src/pools/abstract-pool.ts:156
+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:296
Protected
choose Worker Node
+Defined in src/pools/abstract-pool.ts:340
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:406
+Defined in src/pools/thread/fixed.ts:78
+Defined in src/pools/abstract-pool.ts:555
+Defined in src/pools/abstract-pool.ts:259
+Defined in src/pools/thread/fixed.ts:54
+Defined in src/pools/abstract-pool.ts:551
+Defined in src/pools/abstract-pool.ts:236
+Defined in src/pools/abstract-pool.ts:229
Protected
flush Tasks Queue
+Defined in src/pools/abstract-pool.ts:563
Protected
flush Tasks Queue By Worker
+Defined in src/pools/abstract-pool.ts:572
+Defined in src/pools/abstract-pool.ts:221
+Defined in src/pools/thread/fixed.ts:49
register Worker Message Listener
+Defined in src/pools/thread/fixed.ts:70
Protected
remove Worker Node
+Defined in src/pools/abstract-pool.ts:545
+Defined in src/pools/thread/fixed.ts:62
+Defined in src/pools/abstract-pool.ts:189
+Defined in src/pools/abstract-pool.ts:281
Protected
tasks Queue Length
+Defined in src/pools/abstract-pool.ts:559
Protected
worker Listener
@@ -633,7 +633,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:429
+Defined in src/pools/abstract-pool.ts:68
Readonly
number Of Workers
number Of Workers: number
@@ -158,7 +158,7 @@
+Defined in src/pools/abstract-pool.ts:67
Readonly
opts
@@ -166,7 +166,7 @@
+Defined in src/pools/cluster/fixed.ts:53
Protected
promise Response Map
promise Response Map: Map < string , PromiseResponseWrapper < Worker , Response > > = ...
@@ -179,7 +179,7 @@
+Defined in src/pools/abstract-pool.ts:43
Protected
worker Choice Strategy Context
worker Choice Strategy Context: WorkerChoiceStrategyContext < Worker , Data , Response >
@@ -188,7 +188,7 @@
+Defined in src/pools/abstract-pool.ts:53
Readonly
worker Nodes
worker Nodes: WorkerNode < Worker , Data > [] = []
@@ -196,7 +196,7 @@
Inherit Doc
+Defined in src/pools/abstract-pool.ts:30
+Defined in src/pools/cluster/fixed.ts:104
Private
number Of Queued Tasks
+Defined in src/pools/abstract-pool.ts:166
Private
number Of Running Tasks
+Defined in src/pools/abstract-pool.ts:156
+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:296
Protected
choose Worker Node
+Defined in src/pools/abstract-pool.ts:340
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:406
+Defined in src/pools/cluster/fixed.ts:88
+Defined in src/pools/abstract-pool.ts:555
+Defined in src/pools/abstract-pool.ts:259
+Defined in src/pools/cluster/fixed.ts:69
+Defined in src/pools/abstract-pool.ts:551
+Defined in src/pools/abstract-pool.ts:236
+Defined in src/pools/abstract-pool.ts:229
Protected
flush Tasks Queue
+Defined in src/pools/abstract-pool.ts:563
Protected
flush Tasks Queue By Worker
+Defined in src/pools/abstract-pool.ts:572
+Defined in src/pools/abstract-pool.ts:221
+Defined in src/pools/cluster/fixed.ts:64
register Worker Message Listener
+Defined in src/pools/cluster/fixed.ts:80
Protected
remove Worker Node
+Defined in src/pools/abstract-pool.ts:545
+Defined in src/pools/cluster/fixed.ts:75
+Defined in src/pools/abstract-pool.ts:189
+Defined in src/pools/cluster/fixed.ts:59
Protected
tasks Queue Length
+Defined in src/pools/abstract-pool.ts:559
Protected
worker Listener
@@ -622,7 +622,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:429
+Defined in src/pools/abstract-pool.ts:68
Readonly
number Of Workers
number Of Workers: number
@@ -158,7 +158,7 @@
+Defined in src/pools/abstract-pool.ts:67
Readonly
opts
@@ -166,7 +166,7 @@
+Defined in src/pools/abstract-pool.ts:69
Protected
promise Response Map
@@ -179,7 +179,7 @@
+Defined in src/pools/abstract-pool.ts:43
Protected
worker Choice Strategy Context
@@ -188,7 +188,7 @@
+Defined in src/pools/abstract-pool.ts:53
Readonly
worker Nodes
@@ -196,7 +196,7 @@
Inherit Doc
+Defined in src/pools/abstract-pool.ts:30
+Defined in src/pools/thread/fixed.ts:100
Private
number Of Queued Tasks
+Defined in src/pools/abstract-pool.ts:166
Private
number Of Running Tasks
+Defined in src/pools/abstract-pool.ts:156
+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:296
Protected
choose Worker Node
+Defined in src/pools/abstract-pool.ts:340
Protected
create And Setup Worker
+Defined in src/pools/abstract-pool.ts:406
+Defined in src/pools/thread/fixed.ts:78
+Defined in src/pools/abstract-pool.ts:555
+Defined in src/pools/abstract-pool.ts:259
+Defined in src/pools/thread/fixed.ts:54
+Defined in src/pools/abstract-pool.ts:551
+Defined in src/pools/abstract-pool.ts:236
+Defined in src/pools/abstract-pool.ts:229
Protected
flush Tasks Queue
+Defined in src/pools/abstract-pool.ts:563
Protected
flush Tasks Queue By Worker
+Defined in src/pools/abstract-pool.ts:572
+Defined in src/pools/abstract-pool.ts:221
+Defined in src/pools/thread/fixed.ts:49
register Worker Message Listener
+Defined in src/pools/thread/fixed.ts:70
Protected
remove Worker Node
+Defined in src/pools/abstract-pool.ts:545
+Defined in src/pools/thread/fixed.ts:62
+Defined in src/pools/abstract-pool.ts:189
+Defined in src/pools/abstract-pool.ts:281
Protected
tasks Queue Length
+Defined in src/pools/abstract-pool.ts:559
Protected
worker Listener
@@ -623,7 +623,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:429
+Defined in src/worker/abstract-worker.ts:43
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:45
Protected
Readonly
opts
@@ -161,7 +161,7 @@ but the minimum number of workers will be guaranteed.
+Defined in src/worker/abstract-worker.ts:46
+Defined in src/worker/abstract-worker.ts:129
+Defined in src/worker/abstract-worker.ts:161
Protected
message Listener
+Defined in src/worker/abstract-worker.ts:84
+Defined in src/worker/abstract-worker.ts:171
+Defined in src/worker/abstract-worker.ts:198
+Defined in src/worker/thread-worker.ts:36
trigger Async Id
diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html
index 16dd4fc7..2489805c 100644
--- a/docs/interfaces/ClusterPoolOptions.html
+++ b/docs/interfaces/ClusterPoolOptions.html
@@ -25,7 +25,7 @@
+Defined in src/pools/cluster/fixed.ts:11
Optional
Experimental
enable Tasks Queue
enable Tasks Queue?: boolean
@@ -65,7 +65,7 @@
+Defined in src/pools/pool.ts:71
+Defined in src/pools/cluster/fixed.ts:18
Optional
error Handler
@@ -82,7 +82,7 @@
+Defined in src/pools/pool.ts:42
Optional
exit Handler
@@ -90,7 +90,7 @@
+Defined in src/pools/pool.ts:50
Optional
message Handler
@@ -98,7 +98,7 @@
+Defined in src/pools/pool.ts:38
Optional
online Handler
@@ -106,7 +106,7 @@
+Defined in src/pools/pool.ts:46
+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"
@@ -123,7 +123,7 @@
+Defined in src/pools/pool.ts:54
Optional
worker Choice Strategy Options
@@ -131,7 +131,7 @@
+Defined in src/pools/pool.ts:58
+Defined in src/pools/pool.ts:100
Optional
Readonly
emitter
@@ -75,7 +75,7 @@
+Defined in src/pools/pool.ts:89
execute
execute: ( ( data: Data ) => Promise < Response > )
@@ -99,7 +99,7 @@
Returns Promise < Response >
+Defined in src/pools/pool.ts:96
set Worker Choice Strategy
set Worker Choice Strategy: ( ( workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" ) => void )
@@ -121,7 +121,7 @@
Returns void
+Defined in src/pools/pool.ts:106
+Defined in src/pools/pool.ts:71
+Defined in src/pools/pool.ts:42
+Defined in src/pools/pool.ts:50
+Defined in src/pools/pool.ts:38
+Defined in src/pools/pool.ts:46
Optional
worker Choice Strategy
worker Choice Strategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+Defined in src/pools/pool.ts:54
Optional
worker Choice Strategy Options
+Defined in src/pools/pool.ts:58
+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/worker.ts:11
+Defined in src/pools/worker.ts:21
+Defined in src/pools/worker.ts:6
+Defined in src/pools/worker.ts:16
Maximum number of workers that can be created by this pool.