From ba92b02f642f229cb927ab526148f10107831471 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 5 Apr 2023 11:34:34 +0000 Subject: [PATCH] chore: generate documentation --- docs/classes/ClusterWorker.html | 28 ++++---- docs/classes/DynamicClusterPool.html | 66 +++++++++---------- docs/classes/DynamicThreadPool.html | 66 +++++++++---------- docs/classes/FixedClusterPool.html | 62 ++++++++--------- docs/classes/FixedThreadPool.html | 62 ++++++++--------- docs/classes/PoolEmitter.html | 2 +- docs/classes/ThreadWorker.html | 28 ++++---- 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, 191 insertions(+), 191 deletions(-) diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 4fec31f3..efddf4c5 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:47
  • 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:49
  • opts: WorkerOptions
    @@ -161,7 +161,7 @@ but the minimum number of workers will be guaranteed.

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

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

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:143
  • +
  • Defined in src/worker/abstract-worker.ts:126
  • +
  • Defined in src/worker/cluster-worker.ts:47
  • +
  • Defined in src/worker/abstract-worker.ts:80
  • +
  • Defined in src/worker/abstract-worker.ts:168
  • +
  • Defined in src/worker/abstract-worker.ts:191
  • +
  • Defined in src/worker/cluster-worker.ts:42
  • +
  • Defined in src/pools/cluster/dynamic.ts:16
  • @@ -129,7 +129,7 @@ When the maximum number of workers is reached, an event is emitted. If you want

    Returns DynamicClusterPool<Data, Response>

    +
  • Defined in src/pools/cluster/dynamic.ts:28
  • Properties

    @@ -139,7 +139,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:32
  • filePath: string
    @@ -147,14 +147,14 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:67
  • max: number

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

    +
  • Defined in src/pools/cluster/dynamic.ts:30
  • numberOfWorkers: number
    @@ -162,7 +162,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:66
  • opts: ClusterPoolOptions = {}
    @@ -170,7 +170,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/cluster/fixed.ts:53
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -183,7 +183,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:42
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -192,7 +192,7 @@ When the maximum number of workers is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:52
  • workers: WorkerType<Worker>[] = []
    @@ -200,7 +200,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

    @@ -213,7 +213,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:48
  • +
  • Defined in src/pools/cluster/dynamic.ts:43
  • +
  • Defined in src/pools/abstract-pool.ts:153
  • +
  • Defined in src/pools/cluster/dynamic.ts:38
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:267
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/abstract-pool.ts:256
  • +
  • Defined in src/pools/abstract-pool.ts:307
  • +
  • Defined in src/pools/abstract-pool.ts:352
  • +
  • Defined in src/pools/cluster/fixed.ts:88
  • +
  • Defined in src/pools/abstract-pool.ts:222
  • +
  • Defined in src/pools/cluster/fixed.ts:69
  • +
  • Defined in src/pools/abstract-pool.ts:207
  • +
  • Defined in src/pools/abstract-pool.ts:200
  • +
  • Defined in src/pools/abstract-pool.ts:192
  • +
  • Defined in src/pools/cluster/fixed.ts:64
  • +
  • Defined in src/pools/cluster/fixed.ts:80
  • +
  • Defined in src/pools/abstract-pool.ts:294
  • +
  • Defined in src/pools/cluster/fixed.ts:75
  • +
  • Defined in src/pools/abstract-pool.ts:168
  • +
  • Defined in src/pools/cluster/fixed.ts:59
  • +
  • Defined in src/pools/abstract-pool.ts:381
  • +
  • Defined in src/pools/abstract-pool.ts:67
  • max: number

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

    +
  • Defined in src/pools/thread/dynamic.ts:31
  • numberOfWorkers: number
    @@ -162,7 +162,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:66
  • opts: PoolOptions<ThreadWorkerWithMessageChannel>
    @@ -170,7 +170,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:68
  • promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -183,7 +183,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:42
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -192,7 +192,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:52
  • workers: WorkerType<ThreadWorkerWithMessageChannel>[] = []
    @@ -200,7 +200,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

    @@ -213,7 +213,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:49
  • +
  • Defined in src/pools/thread/dynamic.ts:44
  • +
  • Defined in src/pools/abstract-pool.ts:153
  • +
  • Defined in src/pools/thread/dynamic.ts:39
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:267
  • +
  • Defined in src/pools/thread/fixed.ts:85
  • +
  • Defined in src/pools/abstract-pool.ts:256
  • +
  • Defined in src/pools/abstract-pool.ts:307
  • +
  • Defined in src/pools/abstract-pool.ts:352
  • +
  • Defined in src/pools/thread/fixed.ts:78
  • +
  • Defined in src/pools/abstract-pool.ts:222
  • +
  • Defined in src/pools/thread/fixed.ts:54
  • +
  • Defined in src/pools/abstract-pool.ts:207
  • +
  • Defined in src/pools/abstract-pool.ts:200
  • +
  • Defined in src/pools/abstract-pool.ts:192
  • +
  • Defined in src/pools/thread/fixed.ts:49
  • +
  • Defined in src/pools/thread/fixed.ts:70
  • +
  • Defined in src/pools/abstract-pool.ts:294
  • +
  • Defined in src/pools/thread/fixed.ts:62
  • +
  • Defined in src/pools/abstract-pool.ts:168
  • +
  • Defined in src/pools/abstract-pool.ts:241
  • +
  • Defined in src/pools/abstract-pool.ts:381
  • +
  • Defined in src/pools/abstract-pool.ts:67
  • numberOfWorkers: number
    @@ -152,7 +152,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:66
  • opts: ClusterPoolOptions = {}
    @@ -160,7 +160,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:53
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -173,7 +173,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:42
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -182,7 +182,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:52
  • workers: WorkerType<Worker>[] = []
    @@ -190,7 +190,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:29
  • Accessors

    @@ -203,7 +203,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:153
  • +
  • Defined in src/pools/cluster/fixed.ts:99
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:267
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/abstract-pool.ts:256
  • +
  • Defined in src/pools/abstract-pool.ts:307
  • +
  • Defined in src/pools/abstract-pool.ts:352
  • +
  • Defined in src/pools/cluster/fixed.ts:88
  • +
  • Defined in src/pools/abstract-pool.ts:222
  • +
  • Defined in src/pools/cluster/fixed.ts:69
  • +
  • Defined in src/pools/abstract-pool.ts:207
  • +
  • Defined in src/pools/abstract-pool.ts:200
  • +
  • Defined in src/pools/abstract-pool.ts:192
  • +
  • Defined in src/pools/cluster/fixed.ts:64
  • +
  • Defined in src/pools/cluster/fixed.ts:80
  • +
  • Defined in src/pools/abstract-pool.ts:294
  • +
  • Defined in src/pools/cluster/fixed.ts:75
  • +
  • Defined in src/pools/abstract-pool.ts:168
  • +
  • Defined in src/pools/cluster/fixed.ts:59
  • +
  • Defined in src/pools/abstract-pool.ts:381
  • +
  • Defined in src/pools/abstract-pool.ts:67
  • numberOfWorkers: number
    @@ -152,7 +152,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:66
  • opts: PoolOptions<ThreadWorkerWithMessageChannel>
    @@ -160,7 +160,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:68
  • promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -173,7 +173,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:42
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -182,7 +182,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:52
  • workers: WorkerType<ThreadWorkerWithMessageChannel>[] = []
    @@ -190,7 +190,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:29
  • Accessors

    @@ -203,7 +203,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:153
  • +
  • Defined in src/pools/thread/fixed.ts:95
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:267
  • +
  • Defined in src/pools/thread/fixed.ts:85
  • +
  • Defined in src/pools/abstract-pool.ts:256
  • +
  • Defined in src/pools/abstract-pool.ts:307
  • +
  • Defined in src/pools/abstract-pool.ts:352
  • +
  • Defined in src/pools/thread/fixed.ts:78
  • +
  • Defined in src/pools/abstract-pool.ts:222
  • +
  • Defined in src/pools/thread/fixed.ts:54
  • +
  • Defined in src/pools/abstract-pool.ts:207
  • +
  • Defined in src/pools/abstract-pool.ts:200
  • +
  • Defined in src/pools/abstract-pool.ts:192
  • +
  • Defined in src/pools/thread/fixed.ts:49
  • +
  • Defined in src/pools/thread/fixed.ts:70
  • +
  • Defined in src/pools/abstract-pool.ts:294
  • +
  • Defined in src/pools/thread/fixed.ts:62
  • +
  • Defined in src/pools/abstract-pool.ts:168
  • +
  • Defined in src/pools/abstract-pool.ts:241
  • +
  • Defined in src/pools/abstract-pool.ts:381
  • +
  • Defined in src/worker/abstract-worker.ts:47
  • 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:49
  • opts: WorkerOptions
    @@ -161,7 +161,7 @@ but the minimum number of workers will be guaranteed.

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

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

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:143
  • +
  • Defined in src/worker/abstract-worker.ts:126
  • +
  • Defined in src/worker/abstract-worker.ts:158
  • +
  • Defined in src/worker/abstract-worker.ts:80
  • +
  • Defined in src/worker/abstract-worker.ts:168
  • +
  • Defined in src/worker/abstract-worker.ts:191
  • +
  • Defined in src/worker/thread-worker.ts:36
  • +
  • Defined in src/pools/cluster/fixed.ts:11
  • @@ -53,7 +53,7 @@
    +
  • Defined in src/pools/pool.ts:44
  • env?: any
    @@ -62,7 +62,7 @@

    See

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

    +
  • Defined in src/pools/cluster/fixed.ts:18
  • errorHandler?: ErrorHandler<Worker>
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/pool.ts:26
  • exitHandler?: ExitHandler<Worker>
    @@ -78,7 +78,7 @@
    +
  • Defined in src/pools/pool.ts:34
  • messageHandler?: MessageHandler<Worker>
    @@ -86,7 +86,7 @@
    +
  • Defined in src/pools/pool.ts:22
  • onlineHandler?: OnlineHandler<Worker>
    @@ -94,7 +94,7 @@
    +
  • Defined in src/pools/pool.ts:30
  • settings?: ClusterSettings
    @@ -103,7 +103,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"
    @@ -111,7 +111,7 @@
    +
  • Defined in src/pools/pool.ts:38
  • +
  • Defined in src/pools/pool.ts:72
  • emitter?: PoolEmitter
    @@ -74,7 +74,7 @@
    +
  • Defined in src/pools/pool.ts:61
  • execute: ((data: Data) => Promise<Response>)
    @@ -98,7 +98,7 @@

    Returns Promise<Response>

    +
  • Defined in src/pools/pool.ts:68
  • setWorkerChoiceStrategy: ((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
  • 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/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