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

    • Protected Readonly isMain

    isMain: boolean
    @@ -137,7 +137,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected lastTaskTimestamp

    lastTaskTimestamp: number
    @@ -145,7 +145,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected mainWorker

    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

    • Readonly opts

    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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • triggerAsyncId

    +
  • 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

    • Readonly filePath

    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

    • Private Readonly max

    max: number

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

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

    • Readonly numberOfWorkers

    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

    • Readonly opts

    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

    • Protected promiseResponseMap

    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

    • Protected workerChoiceStrategyContext

    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

    • Readonly workers

    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

    • full

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

    • Private numberOfRunningTasks

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

    • type

    +
  • 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

    • Protected afterWorkerSetup

    +
  • Defined in src/pools/cluster/fixed.ts:93

    • Protected beforePromiseResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

    +
  • Defined in src/pools/cluster/fixed.ts:88

    • destroy

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

    • destroyWorker

    +
  • Defined in src/pools/cluster/fixed.ts:69

    • execute

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

    • findFreeWorkerKey

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

    • Protected internalBusy

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

    • Protected isMain

    +
  • Defined in src/pools/cluster/fixed.ts:64

    • registerWorkerMessageListener

    +
  • Defined in src/pools/cluster/fixed.ts:80

    • Protected removeWorker

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

    • Protected sendToWorker

    +
  • Defined in src/pools/cluster/fixed.ts:75

    • setWorkerChoiceStrategy

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

    • Protected setupHook

    +
  • Defined in src/pools/cluster/fixed.ts:59

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:381
    • diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index bda91d61..66f365d3 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -18,7 +18,7 @@

    A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.

    This thread pool creates new threads when the others are busy, up to the maximum number of threads. -When the maximum number of threads is reached, an event is emitted. If you want to listen to this event, use the pool's emitter.

    +When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's emitter.

    Author

    Alessandro Pio Ardizio

    @@ -42,7 +42,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    • DynamicThreadPool
    +
  • Defined in src/pools/thread/dynamic.ts:17
    • @@ -129,7 +129,7 @@ When the maximum number of threads is reached, an event is emitted. If you want

    Returns DynamicThreadPool<Data, Response>

    +
  • Defined in src/pools/thread/dynamic.ts:29

    • Properties

    @@ -139,7 +139,7 @@ When the maximum number of threads is reached, an event is emitted. If you want
    +
  • Defined in src/pools/abstract-pool.ts:32

    • Readonly filePath

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

    • Private Readonly max

    max: number

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

    +
  • Defined in src/pools/thread/dynamic.ts:31

    • Readonly numberOfWorkers

    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

    • Readonly opts

    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

    • Protected promiseResponseMap

    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

    • Protected workerChoiceStrategyContext

    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

    • Readonly workers

    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

    • full

    +
  • Defined in src/pools/thread/dynamic.ts:44

    • Private numberOfRunningTasks

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

    • type

    +
  • 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

    • Protected afterWorkerSetup

    +
  • Defined in src/pools/thread/fixed.ts:85

    • Protected beforePromiseResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

    +
  • Defined in src/pools/thread/fixed.ts:78

    • destroy

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

    • destroyWorker

    +
  • Defined in src/pools/thread/fixed.ts:54

    • execute

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

    • findFreeWorkerKey

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

    • Protected internalBusy

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

    • Protected isMain

    +
  • Defined in src/pools/thread/fixed.ts:49

    • registerWorkerMessageListener

    +
  • Defined in src/pools/thread/fixed.ts:70

    • Protected removeWorker

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

    • Protected sendToWorker

    +
  • Defined in src/pools/thread/fixed.ts:62

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:381
    • diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 9847d27b..d491a4d4 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:39
    • @@ -126,7 +126,7 @@

    Returns FixedClusterPool<Data, Response>

    +
  • Defined in src/pools/cluster/fixed.ts:50

    • Properties

    @@ -136,7 +136,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:32

    • Readonly filePath

    filePath: string
    @@ -144,7 +144,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:67

    • Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -152,7 +152,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:66

    • Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -160,7 +160,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:53

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -173,7 +173,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:42

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -182,7 +182,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:52

    • Readonly workers

    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

    • full

    +
  • Defined in src/pools/cluster/fixed.ts:104

    • Private numberOfRunningTasks

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

    • type

    +
  • 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

    • Protected afterWorkerSetup

    +
  • Defined in src/pools/cluster/fixed.ts:93

    • Protected beforePromiseResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

    +
  • Defined in src/pools/cluster/fixed.ts:88

    • destroy

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

    • destroyWorker

    +
  • Defined in src/pools/cluster/fixed.ts:69

    • execute

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

    • findFreeWorkerKey

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

    • Protected internalBusy

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

    • Protected isMain

    +
  • Defined in src/pools/cluster/fixed.ts:64

    • registerWorkerMessageListener

    +
  • Defined in src/pools/cluster/fixed.ts:80

    • Protected removeWorker

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

    • Protected sendToWorker

    +
  • Defined in src/pools/cluster/fixed.ts:75

    • setWorkerChoiceStrategy

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

    • Protected setupHook

    +
  • Defined in src/pools/cluster/fixed.ts:59

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:381
    • diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 7b890594..bdaa69de 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/thread/fixed.ts:29
    • @@ -126,7 +126,7 @@

    Returns FixedThreadPool<Data, Response>

    +
  • Defined in src/pools/thread/fixed.ts:40

    • Properties

    @@ -136,7 +136,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:32

    • Readonly filePath

    filePath: string
    @@ -144,7 +144,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:67

    • Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -152,7 +152,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:66

    • Readonly opts

    opts: PoolOptions<ThreadWorkerWithMessageChannel>
    @@ -160,7 +160,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:68

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -173,7 +173,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:42

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -182,7 +182,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:52

    • Readonly workers

    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

    • full

    +
  • Defined in src/pools/thread/fixed.ts:100

    • Private numberOfRunningTasks

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

    • type

    +
  • 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

    • Protected afterWorkerSetup

    +
  • Defined in src/pools/thread/fixed.ts:85

    • Protected beforePromiseResponseHook

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

    • Protected chooseWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

    +
  • Defined in src/pools/thread/fixed.ts:78

    • destroy

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

    • destroyWorker

    +
  • Defined in src/pools/thread/fixed.ts:54

    • execute

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

    • findFreeWorkerKey

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

    • Protected internalBusy

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

    • Protected isMain

    +
  • Defined in src/pools/thread/fixed.ts:49

    • registerWorkerMessageListener

    +
  • Defined in src/pools/thread/fixed.ts:70

    • Protected removeWorker

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

    • Protected sendToWorker

    +
  • Defined in src/pools/thread/fixed.ts:62

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:381
    • diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index 661143a0..4503b6ba 100644 --- a/docs/classes/PoolEmitter.html +++ b/docs/classes/PoolEmitter.html @@ -25,7 +25,7 @@
    • PoolEmitter
    +
  • Defined in src/pools/pool.ts:13
    • diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 1774dd26..162fb1cf 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -44,7 +44,7 @@ but the minimum number of workers will be guaranteed.

    • ThreadWorker
    +
  • Defined in src/worker/thread-worker.ts:21
    • @@ -119,7 +119,7 @@ but the minimum number of workers will be guaranteed.

    Returns ThreadWorker<Data, Response>

    +
  • Defined in src/worker/thread-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

    • Protected Readonly isMain

    isMain: boolean
    @@ -137,7 +137,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected lastTaskTimestamp

    lastTaskTimestamp: number
    @@ -145,7 +145,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected mainWorker

    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

    • Readonly opts

    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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

    +
  • Defined in src/worker/thread-worker.ts:36

    • triggerAsyncId

    +
  • Defined in src/pools/cluster/fixed.ts:11
    • @@ -53,7 +53,7 @@
    +
  • Defined in src/pools/pool.ts:44

    • Optional env

    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

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/pool.ts:26

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>
    @@ -78,7 +78,7 @@
    +
  • Defined in src/pools/pool.ts:34

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>
    @@ -86,7 +86,7 @@
    +
  • Defined in src/pools/pool.ts:22

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>
    @@ -94,7 +94,7 @@
    +
  • Defined in src/pools/pool.ts:30

    • Optional settings

    settings?: ClusterSettings
    @@ -103,7 +103,7 @@

    See

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

    +
  • Defined in src/pools/cluster/fixed.ts:24

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    @@ -111,7 +111,7 @@
    +
  • Defined in src/pools/pool.ts:38
    • diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 43cd610e..4567e002 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -34,7 +34,7 @@
    • IPool
    +
  • Defined in src/pools/pool.ts:53
    • @@ -63,7 +63,7 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:72

    • Optional Readonly emitter

    emitter?: PoolEmitter
    @@ -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

    • setWorkerChoiceStrategy

    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
    • diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 9530e94f..77d27275 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -30,7 +30,7 @@ +
  • Defined in src/pools/pool.ts:18
    • @@ -55,42 +55,42 @@

    Default Value

    true

    +
  • Defined in src/pools/pool.ts:44

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>

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

    +
  • Defined in src/pools/pool.ts:26

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>

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

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

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>

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

    +
  • Defined in src/pools/pool.ts:22

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>

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

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

    • Optional workerChoiceStrategy

    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:38
    • diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 69eb5bb1..6aded9f6 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -23,7 +23,7 @@
    • WorkerOptions
    +
  • Defined in src/worker/worker-options.ts:38
    • @@ -45,7 +45,7 @@

    Default Value

    false

    +
  • Defined in src/worker/worker-options.ts:57

    • Optional killBehavior

    killBehavior?: "SOFT" | "HARD"
    @@ -59,7 +59,7 @@

    Default Value

    KillBehaviors.SOFT

    +
  • Defined in src/worker/worker-options.ts:68

    • Optional maxInactiveTime

    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
    • diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index fa1ff427..82523f78 100644 --- a/docs/types/ErrorHandler.html +++ b/docs/types/ErrorHandler.html @@ -39,7 +39,7 @@
    e: Error

    Returns void

    +
  • Defined in src/pools/pool-worker.ts:9
    • diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html index 01d86050..1c920d64 100644 --- a/docs/types/ExitHandler.html +++ b/docs/types/ExitHandler.html @@ -39,7 +39,7 @@
    code: number

    Returns void

    +
  • Defined in src/pools/pool-worker.ts:19
    • diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html index 3fdaeba5..16e799cd 100644 --- a/docs/types/KillBehavior.html +++ b/docs/types/KillBehavior.html @@ -19,7 +19,7 @@

    Kill behavior.

    +
  • Defined in src/worker/worker-options.ts:18
    • diff --git a/docs/types/MessageHandler.html b/docs/types/MessageHandler.html index 6577428f..ffeae05f 100644 --- a/docs/types/MessageHandler.html +++ b/docs/types/MessageHandler.html @@ -39,7 +39,7 @@
    m: unknown

    Returns void

    +
  • Defined in src/pools/pool-worker.ts:4
    • diff --git a/docs/types/OnlineHandler.html b/docs/types/OnlineHandler.html index 6e78158f..dc9c3772 100644 --- a/docs/types/OnlineHandler.html +++ b/docs/types/OnlineHandler.html @@ -37,7 +37,7 @@
    this: Worker

    Returns void

    +
  • Defined in src/pools/pool-worker.ts:14
    • diff --git a/docs/types/ThreadWorkerWithMessageChannel.html b/docs/types/ThreadWorkerWithMessageChannel.html index 17d614f4..a40dba85 100644 --- a/docs/types/ThreadWorkerWithMessageChannel.html +++ b/docs/types/ThreadWorkerWithMessageChannel.html @@ -19,7 +19,7 @@

    A thread worker with message channels for communication between main thread and thread worker.

    +
  • Defined in src/pools/thread/fixed.ts:15
    • diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index 70d2407f..eca269a3 100644 --- a/docs/types/WorkerChoiceStrategy.html +++ b/docs/types/WorkerChoiceStrategy.html @@ -19,7 +19,7 @@

    Worker choice strategy.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:30
    • diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html index 5ba02a15..11dafe5b 100644 --- a/docs/variables/KillBehaviors.html +++ b/docs/variables/KillBehaviors.html @@ -19,7 +19,7 @@

    Enumeration of kill behaviors.

    +
  • Defined in src/worker/worker-options.ts:4
    • diff --git a/docs/variables/WorkerChoiceStrategies.html b/docs/variables/WorkerChoiceStrategies.html index 9a2dca8c..5e7a7fc3 100644 --- a/docs/variables/WorkerChoiceStrategies.html +++ b/docs/variables/WorkerChoiceStrategies.html @@ -19,7 +19,7 @@

    Enumeration of worker choice strategies.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
    • -- 2.34.1