From 200aca02adb41311beb654c24970049a50df5474 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 22 Oct 2022 12:28:00 +0000 Subject: [PATCH] Generate TypeDoc --- docs/classes/ClusterWorker.html | 26 +++---- docs/classes/DynamicClusterPool.html | 74 +++++++++---------- docs/classes/DynamicThreadPool.html | 74 +++++++++---------- docs/classes/FixedClusterPool.html | 72 +++++++++--------- docs/classes/FixedThreadPool.html | 72 +++++++++--------- 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, 207 insertions(+), 207 deletions(-) diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 5e01e06a..c59df585 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.

    Returns ClusterWorker<Data, Response>

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

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

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

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

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

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

    Returns void

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

    Returns DynamicClusterPool<Data, Response>

    +
  • 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
  • filePath: string
    +
  • Defined in src/pools/abstract-pool.ts:80
  • max: number
    +
  • Defined in src/pools/cluster/dynamic.ts:30
  • nextMessageId: 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
  • numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:79
  • opts: ClusterPoolOptions = {}
    +
  • Defined in src/pools/cluster/fixed.ts:53
  • promiseMap: 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
  • workerChoiceStrategyContext: 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
  • 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
  • workersTasksUsage: 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
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:260
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/abstract-pool.ts:249
  • +
  • Defined in src/pools/abstract-pool.ts:287
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:166
  • +
  • Defined in src/pools/abstract-pool.ts:156
  • +
  • Defined in src/pools/abstract-pool.ts:161
  • +
  • Defined in src/pools/abstract-pool.ts:312
  • +
  • Defined in src/pools/abstract-pool.ts:186
  • +
  • Defined in src/pools/cluster/fixed.ts:64
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:365
  • +
  • Defined in src/pools/abstract-pool.ts:58
  • numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:79
  • opts: PoolOptions<ThreadWorkerWithMessageChannel>
    +
  • Defined in src/pools/abstract-pool.ts:81
  • promiseMap: Map<number, PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -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
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -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
  • workers: ThreadWorkerWithMessageChannel[] = []
    @@ -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
  • workersTasksUsage: Map<ThreadWorkerWithMessageChannel, TasksUsage> = ...
    @@ -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
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:260
  • +
  • Defined in src/pools/thread/fixed.ts:80
  • +
  • Defined in src/pools/abstract-pool.ts:249
  • +
  • Defined in src/pools/abstract-pool.ts:287
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:166
  • +
  • Defined in src/pools/abstract-pool.ts:156
  • +
  • Defined in src/pools/abstract-pool.ts:161
  • +
  • Defined in src/pools/abstract-pool.ts:312
  • +
  • Defined in src/pools/abstract-pool.ts:186
  • +
  • Defined in src/pools/thread/fixed.ts:44
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:365
  • +
  • Defined in src/pools/abstract-pool.ts:58
  • numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:79
  • opts: ClusterPoolOptions = {}
    +
  • Defined in src/pools/cluster/fixed.ts:53
  • promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...
    @@ -180,7 +180,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:50
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -189,7 +189,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65
  • workers: Worker[] = []
    @@ -197,7 +197,7 @@

    Inherit Doc

    +
  • Defined in src/pools/abstract-pool.ts:31
  • workersTasksUsage: Map<Worker, TasksUsage> = ...
    @@ -205,7 +205,7 @@

    Inherit Doc

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

    @@ -218,7 +218,7 @@

    Returns boolean

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

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:260
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/abstract-pool.ts:249
  • +
  • Defined in src/pools/abstract-pool.ts:287
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:166
  • +
  • Defined in src/pools/abstract-pool.ts:156
  • +
  • Defined in src/pools/abstract-pool.ts:161
  • +
  • Defined in src/pools/abstract-pool.ts:312
  • +
  • Defined in src/pools/abstract-pool.ts:186
  • +
  • Defined in src/pools/cluster/fixed.ts:64
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:365
  • +
  • Defined in src/pools/abstract-pool.ts:58
  • numberOfWorkers: number
    +
  • Defined in src/pools/abstract-pool.ts:79
  • opts: PoolOptions<ThreadWorkerWithMessageChannel>
    +
  • Defined in src/pools/abstract-pool.ts:81
  • promiseMap: Map<number, PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -180,7 +180,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:50
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -189,7 +189,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65
  • workers: ThreadWorkerWithMessageChannel[] = []
    @@ -197,7 +197,7 @@

    Inherit Doc

    +
  • Defined in src/pools/abstract-pool.ts:31
  • workersTasksUsage: Map<ThreadWorkerWithMessageChannel, TasksUsage> = ...
    @@ -205,7 +205,7 @@

    Inherit Doc

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

    @@ -218,7 +218,7 @@

    Returns boolean

    +
  • Defined in src/pools/thread/fixed.ts:95
  • +
  • Defined in src/pools/abstract-pool.ts:151
  • +
  • Defined in src/pools/thread/fixed.ts:90
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:260
  • +
  • Defined in src/pools/thread/fixed.ts:80
  • +
  • Defined in src/pools/abstract-pool.ts:249
  • +
  • Defined in src/pools/abstract-pool.ts:287
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:166
  • +
  • Defined in src/pools/abstract-pool.ts:156
  • +
  • Defined in src/pools/abstract-pool.ts:161
  • +
  • Defined in src/pools/abstract-pool.ts:312
  • +
  • Defined in src/pools/abstract-pool.ts:186
  • +
  • Defined in src/pools/thread/fixed.ts:44
  • +
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:365
  • +
  • Defined in src/worker/abstract-worker.ts:27
  • mainWorker: undefined | null | MessagePort
    +
  • Defined in src/worker/abstract-worker.ts:49
  • opts: WorkerOptions
    @@ -150,7 +150,7 @@ but the minimum number of workers will be guaranteed.

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

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

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:141
  • +
  • Defined in src/worker/abstract-worker.ts:124
  • +
  • Defined in src/worker/abstract-worker.ts:156
  • +
  • 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
  • +
  • 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_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
  • Returns Promise<Response>

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

    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