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.

    Returns ClusterWorker<Data, Response>

    +
  • Defined in src/worker/cluster-worker.ts:31
  • Properties

    @@ -129,7 +129,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:31
  • isMain: boolean
    @@ -137,7 +137,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:43
  • lastTaskTimestamp: number
    @@ -145,7 +145,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:27
  • mainWorker: undefined | null | Worker
    @@ -153,7 +153,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:45
  • opts: WorkerOptions = ...
    @@ -161,7 +161,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:46
  • Methods

    @@ -213,7 +213,7 @@ the AsyncResource to which the function is bound.

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:146
  • +
  • Defined in src/worker/abstract-worker.ts:129
  • +
  • Defined in src/worker/cluster-worker.ts:47
  • +
  • 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
  • +
  • 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

    Returns DynamicClusterPool<Data, Response>

    +
  • 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
  • filePath: 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
  • max: number

    Maximum number of workers that can be created by this pool.

    +
  • Defined in src/pools/cluster/dynamic.ts:30
  • numberOfWorkers: 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
  • opts: ClusterPoolOptions = {}
    @@ -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
  • promiseResponseMap: 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
  • workerChoiceStrategyContext: 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
  • workerNodes: 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
  • +
  • Defined in src/pools/abstract-pool.ts:166
  • +
  • Defined in src/pools/abstract-pool.ts:156
  • +
  • Defined in src/pools/cluster/dynamic.ts:38
  • Methods

    @@ -288,7 +288,7 @@ Can be overridden.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:307
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/abstract-pool.ts:296
  • +
  • Defined in src/pools/abstract-pool.ts:340
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:563
  • +
  • Defined in src/pools/abstract-pool.ts:572
  • +
  • Defined in src/pools/abstract-pool.ts:221
  • +
  • Defined in src/pools/cluster/fixed.ts:64
  • +
  • Defined in src/pools/cluster/fixed.ts:80
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:559
  • +
  • Defined in src/pools/abstract-pool.ts:429
  • +
  • Defined in src/pools/abstract-pool.ts:68
  • max: number

    Maximum number of threads that can be created by this pool.

    +
  • Defined in src/pools/thread/dynamic.ts:31
  • numberOfWorkers: 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
  • opts: PoolOptions<ThreadWorkerWithMessageChannel>
    @@ -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
  • promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -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
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -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
  • workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    @@ -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
  • +
  • Defined in src/pools/abstract-pool.ts:166
  • +
  • Defined in src/pools/abstract-pool.ts:156
  • +
  • Defined in src/pools/thread/dynamic.ts:39
  • Methods

    @@ -288,7 +288,7 @@ Can be overridden.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:307
  • +
  • Defined in src/pools/thread/fixed.ts:85
  • +
  • Defined in src/pools/abstract-pool.ts:296
  • +
  • Defined in src/pools/abstract-pool.ts:340
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:563
  • +
  • Defined in src/pools/abstract-pool.ts:572
  • +
  • Defined in src/pools/abstract-pool.ts:221
  • +
  • Defined in src/pools/thread/fixed.ts:49
  • +
  • Defined in src/pools/thread/fixed.ts:70
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:559
  • +
  • Defined in src/pools/abstract-pool.ts:429
  • +
  • Defined in src/pools/abstract-pool.ts:68
  • numberOfWorkers: number
    @@ -158,7 +158,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:67
  • opts: ClusterPoolOptions = {}
    @@ -166,7 +166,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:53
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -179,7 +179,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:43
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -188,7 +188,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:53
  • workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -196,7 +196,7 @@

    Inherit Doc

    +
  • Defined in src/pools/abstract-pool.ts:30
  • Accessors

    @@ -209,7 +209,7 @@

    Returns boolean

    +
  • Defined in src/pools/cluster/fixed.ts:109
  • +
  • Defined in src/pools/cluster/fixed.ts:104
  • +
  • Defined in src/pools/abstract-pool.ts:166
  • +
  • Defined in src/pools/abstract-pool.ts:156
  • +
  • Defined in src/pools/cluster/fixed.ts:99
  • Methods

    @@ -278,7 +278,7 @@ Can be overridden.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:307
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/abstract-pool.ts:296
  • +
  • Defined in src/pools/abstract-pool.ts:340
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:563
  • +
  • Defined in src/pools/abstract-pool.ts:572
  • +
  • Defined in src/pools/abstract-pool.ts:221
  • +
  • Defined in src/pools/cluster/fixed.ts:64
  • +
  • Defined in src/pools/cluster/fixed.ts:80
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:559
  • +
  • Defined in src/pools/abstract-pool.ts:429
  • +
  • Defined in src/pools/abstract-pool.ts:68
  • numberOfWorkers: number
    @@ -158,7 +158,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:67
  • opts: PoolOptions<ThreadWorkerWithMessageChannel>
    @@ -166,7 +166,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:69
  • promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -179,7 +179,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:43
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -188,7 +188,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:53
  • workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    @@ -196,7 +196,7 @@

    Inherit Doc

    +
  • Defined in src/pools/abstract-pool.ts:30
  • Accessors

    @@ -209,7 +209,7 @@

    Returns boolean

    +
  • Defined in src/pools/thread/fixed.ts:105
  • +
  • Defined in src/pools/thread/fixed.ts:100
  • +
  • Defined in src/pools/abstract-pool.ts:166
  • +
  • Defined in src/pools/abstract-pool.ts:156
  • +
  • Defined in src/pools/thread/fixed.ts:95
  • Methods

    @@ -278,7 +278,7 @@ Can be overridden.

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:307
  • +
  • Defined in src/pools/thread/fixed.ts:85
  • +
  • Defined in src/pools/abstract-pool.ts:296
  • +
  • Defined in src/pools/abstract-pool.ts:340
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:563
  • +
  • Defined in src/pools/abstract-pool.ts:572
  • +
  • Defined in src/pools/abstract-pool.ts:221
  • +
  • Defined in src/pools/thread/fixed.ts:49
  • +
  • Defined in src/pools/thread/fixed.ts:70
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:559
  • +
  • Defined in src/pools/abstract-pool.ts:429
  • +
  • Defined in src/worker/abstract-worker.ts:43
  • lastTaskTimestamp: number
    @@ -145,7 +145,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:27
  • mainWorker: undefined | null | MessagePort
    @@ -153,7 +153,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:45
  • opts: WorkerOptions = ...
    @@ -161,7 +161,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:46
  • Methods

    @@ -213,7 +213,7 @@ the AsyncResource to which the function is bound.

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:146
  • +
  • Defined in src/worker/abstract-worker.ts:129
  • +
  • Defined in src/worker/abstract-worker.ts:161
  • +
  • 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
  • +
  • Defined in src/pools/cluster/fixed.ts:11
  • @@ -55,7 +55,7 @@
    +
  • Defined in src/pools/pool.ts:64
  • enableTasksQueue?: boolean
    @@ -65,7 +65,7 @@
    +
  • Defined in src/pools/pool.ts:71
  • env?: any
    @@ -74,7 +74,7 @@

    See

    https://nodejs.org/api/cluster.html#cluster_cluster_fork_env

    +
  • Defined in src/pools/cluster/fixed.ts:18
  • errorHandler?: ErrorHandler<Worker>
    @@ -82,7 +82,7 @@
    +
  • Defined in src/pools/pool.ts:42
  • exitHandler?: ExitHandler<Worker>
    @@ -90,7 +90,7 @@
    +
  • Defined in src/pools/pool.ts:50
  • messageHandler?: MessageHandler<Worker>
    @@ -98,7 +98,7 @@
    +
  • Defined in src/pools/pool.ts:38
  • onlineHandler?: OnlineHandler<Worker>
    @@ -106,7 +106,7 @@
    +
  • Defined in src/pools/pool.ts:46
  • settings?: ClusterSettings
    @@ -115,7 +115,7 @@

    See

    https://nodejs.org/api/cluster.html#cluster_cluster_settings

    +
  • Defined in src/pools/cluster/fixed.ts:24
  • workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    @@ -123,7 +123,7 @@
    +
  • Defined in src/pools/pool.ts:54
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -131,7 +131,7 @@
    +
  • Defined in src/pools/pool.ts:58
  • +
  • Defined in src/pools/pool.ts:100
  • emitter?: PoolEmitter
    @@ -75,7 +75,7 @@
    +
  • Defined in src/pools/pool.ts:89
  • execute: ((data: Data) => Promise<Response>)
    @@ -99,7 +99,7 @@

    Returns Promise<Response>

    +
  • Defined in src/pools/pool.ts:96
  • setWorkerChoiceStrategy: ((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
  • errorHandler?: ErrorHandler<Worker>

    A function that will listen for error event on each worker.

    +
  • Defined in src/pools/pool.ts:42
  • exitHandler?: ExitHandler<Worker>

    A function that will listen for exit event on each worker.

    +
  • Defined in src/pools/pool.ts:50
  • messageHandler?: MessageHandler<Worker>

    A function that will listen for message event on each worker.

    +
  • Defined in src/pools/pool.ts:38
  • onlineHandler?: OnlineHandler<Worker>

    A function that will listen for online event on each worker.

    +
  • Defined in src/pools/pool.ts:46
  • workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

    The worker choice strategy to use in this pool.

    +
  • Defined in src/pools/pool.ts:54
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    +
  • Defined in src/pools/pool.ts:58
  • +
  • Defined in src/worker/worker-options.ts:68
  • maxInactiveTime?: 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