From b45edd35eec0fb1d5fd8fa979ff00f17f4e3c24e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 12 Apr 2023 09:19:35 +0000 Subject: [PATCH 1/1] chore: generate documentation --- docs/classes/AbstractPool.html | 98 ++++++++++--------- docs/classes/AbstractWorker.html | 32 +++--- docs/classes/CircularArray.html | 22 ++--- docs/classes/ClusterWorker.html | 28 +++--- docs/classes/DynamicClusterPool.html | 64 ++++++------ docs/classes/DynamicThreadPool.html | 64 ++++++------ docs/classes/FixedClusterPool.html | 62 ++++++------ docs/classes/FixedThreadPool.html | 62 ++++++------ docs/classes/PoolEmitter.html | 2 +- docs/classes/ThreadWorker.html | 28 +++--- docs/classes/WorkerChoiceStrategyContext.html | 16 +-- docs/enums/PoolType.html | 8 +- docs/interfaces/ClusterPoolOptions.html | 24 ++--- docs/interfaces/IPool.html | 16 +-- docs/interfaces/IWorker.html | 6 +- docs/interfaces/IWorkerChoiceStrategy.html | 10 +- docs/interfaces/MessageValue.html | 16 +-- docs/interfaces/PoolOptions.html | 22 ++--- docs/interfaces/PromiseResponseWrapper.html | 8 +- docs/interfaces/RequiredStatistics.html | 10 +- docs/interfaces/Task.html | 6 +- docs/interfaces/TasksQueueOptions.html | 4 +- docs/interfaces/TasksUsage.html | 16 +-- .../WorkerChoiceStrategyOptions.html | 4 +- docs/interfaces/WorkerNode.html | 8 +- docs/interfaces/WorkerOptions.html | 8 +- docs/types/Draft.html | 2 +- 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 +- 38 files changed, 335 insertions(+), 333 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 25e97424..5cc04560 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -45,7 +45,7 @@ +
  • Defined in src/pools/abstract-pool.ts:32
    • @@ -145,7 +145,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

    @@ -160,28 +160,28 @@
    +
  • Defined in src/pools/abstract-pool.ts:41

    • Readonly filePath

    filePath: string

    Path to the worker-file.

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

    • Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

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

    • Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

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

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -193,7 +193,7 @@

    When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

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

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -201,7 +201,7 @@

    Default to a round robin algorithm.

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

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -209,7 +209,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:38

    • Accessors

    @@ -222,7 +222,7 @@

    Returns boolean

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

    • Protected Abstract full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • Abstract type

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

    • Methods

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

    Returns void

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

    • Protected Abstract afterWorkerSetup

    Returns void

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

    • Protected beforeTaskExecutionHook

    Returns void

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

    • Private checkAndEmitEvents

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

    • Private checkFilePath

    Returns void

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

    Returns void | Promise<void>

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • findFreeWorkerNodeKey

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueueByWorker

    Returns void

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

    • Private getWorkerNodeKey

    Returns number

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

    • Private getWorkerTasksUsage

    Returns undefined | TasksUsage

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

    Returns number

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

    • Protected Abstract registerWorkerMessageListener

    Returns void

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

    • Private removeWorkerNode

    Returns void

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

    • Protected Abstract sendToWorker

    Returns void

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

    • setWorkerChoiceStrategy

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

    • Private setWorkerNode

    Returns void

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

    • Private setWorkerNodeTasksUsage

    Returns void

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

    • Protected setupHook

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

    • Private tasksQueueSize

    Returns number

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

    • Protected workerListener

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:453
    • diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 0cc3eca1..cc9478be 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -43,7 +43,7 @@
  • ClusterWorker
  • ThreadWorker
    • +
  • Defined in src/worker/abstract-worker.ts:19
    • @@ -134,7 +134,7 @@

    Returns AbstractWorker<MainWorker, Data, Response>

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

    • Properties

    @@ -143,35 +143,35 @@

    Handler id of the aliveInterval worker alive check.

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

    • Protected Readonly isMain

    isMain: boolean

    Whether this is the main worker or not.

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

    • Protected lastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

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

    • Protected mainWorker

    mainWorker: undefined | null | MainWorker

    Reference to main worker.

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

    • Protected Readonly opts

    opts: WorkerOptions = ...

    Options for the worker.

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

    • Methods

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

    Returns void

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

    • Private checkFunctionInput

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

      Returns Response

    Returns void

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

    • Private checkWorkerOptions

    Returns void

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

    • emitDestroy

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

    • Protected handleError

    Returns string

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

    • Protected messageListener

    Returns void

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

    • Protected run

    Returns void

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

    • Protected runAsync

    Returns void

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

    • runInAsyncScope

    Returns void

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

    • triggerAsyncId

    +
  • Defined in src/circular-array.ts:8
    • @@ -112,7 +112,7 @@

    Returns CircularArray<T>

    +
  • Defined in src/circular-array.ts:11

    • Properties

    @@ -148,7 +148,7 @@ when they will be absent when used in a 'with' statement.

    size

    size: number
    +
  • Defined in src/circular-array.ts:9

    • Static Readonly [species]

    [species]: ArrayConstructor
    +
  • Defined in src/circular-array.ts:84

    • concat

    +
  • Defined in src/circular-array.ts:36

    • copyWithin

    +
  • Defined in src/circular-array.ts:76

    • entries

    +
  • Defined in src/circular-array.ts:80

    • includes

    +
  • Defined in src/circular-array.ts:20

    • reduce

    Returns void

    +
  • Defined in src/circular-array.ts:64

    • reverse

    +
  • Defined in src/circular-array.ts:50

    • toLocaleString

    +
  • Defined in src/circular-array.ts:28

    • values

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

    • 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:45

    • Protected Readonly opts

    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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected run

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

    • Protected runAsync

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

    • 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 and workers are busy, an event is

    Returns DynamicClusterPool<Data, Response>

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

    • Properties

    @@ -144,7 +144,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:41

    • Readonly filePath

    filePath: string
    @@ -152,14 +152,14 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:76

    • 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
    @@ -167,7 +167,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:75

    • Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -175,7 +175,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 promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -188,7 +188,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:51

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -197,7 +197,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:61

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -205,7 +205,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:38

    • 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

    • Protected full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • execute

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

    • findFreeWorkerNodeKey

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected registerWorkerMessageListener

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:453
    • diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 148840ec..b80a2d14 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -42,7 +42,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    • DynamicThreadPool
    +
  • Defined in src/pools/thread/dynamic.ts:17
    • @@ -129,7 +129,7 @@ When the maximum number of threads is reached and workers are busy, an event is

    Returns DynamicThreadPool<Data, Response>

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

    • Properties

    @@ -144,7 +144,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:41

    • Readonly filePath

    filePath: string
    @@ -152,14 +152,14 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:76

    • 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
    @@ -167,7 +167,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:75

    • Readonly opts

    opts: PoolOptions<ThreadWorkerWithMessageChannel>
    @@ -175,7 +175,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:77

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -188,7 +188,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:51

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -197,7 +197,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:61

    • Readonly workerNodes

    workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    @@ -205,7 +205,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:38

    • 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

    • Protected full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • execute

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

    • findFreeWorkerNodeKey

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected registerWorkerMessageListener

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:453
    • diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 2249ac0f..6a1ea798 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

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

    • Readonly filePath

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

    • Readonly numberOfWorkers

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

    • Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -195,7 +195,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:38

    • Accessors

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

    Returns boolean

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

    • Protected full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • execute

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

    • findFreeWorkerNodeKey

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected registerWorkerMessageListener

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:453
    • diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 7683c280..4016d787 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

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

    • Readonly filePath

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

    • Readonly numberOfWorkers

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

    • Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

    workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    @@ -195,7 +195,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:38

    • Accessors

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

    Returns boolean

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

    • Protected full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • execute

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

    • findFreeWorkerNodeKey

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected registerWorkerMessageListener

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

    • Protected sendToWorker

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

    • setWorkerChoiceStrategy

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:453
    • diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index 95694e08..babef8ec 100644 --- a/docs/classes/PoolEmitter.html +++ b/docs/classes/PoolEmitter.html @@ -25,7 +25,7 @@
    • PoolEmitter
    +
  • Defined in src/pools/pool.ts:35
    • diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 8e60862c..2743f3f4 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:43

    • 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:45

    • Protected Readonly opts

    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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • triggerAsyncId

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:24
    • @@ -95,21 +95,21 @@

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:41

    • Properties

    Private Readonly workerChoiceStrategies

    workerChoiceStrategies: Map<"ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:29

    • Private workerChoiceStrategyType

    workerChoiceStrategyType: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

    The worker choice strategy.

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:43

    • Methods

    @@ -123,7 +123,7 @@

    Returns number

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:109

    • getRequiredStatistics

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:82

    • remove

    Returns boolean

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:123

    • setWorkerChoiceStrategy

    Returns void

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:95
    • diff --git a/docs/enums/PoolType.html b/docs/enums/PoolType.html index ce656455..f985a2a1 100644 --- a/docs/enums/PoolType.html +++ b/docs/enums/PoolType.html @@ -14,12 +14,12 @@ -

    Enumeration PoolType

    +

    Enumeration PoolTypeInternal

    Pool types.

    +
  • Defined in src/pools/pool.ts:21
    • @@ -38,14 +38,14 @@

    Dynamic pool type.

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

    • FIXED

    FIXED: "fixed"

    Fixed pool type.

    +
  • Defined in src/pools/pool.ts:25
    • diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 54c1ba49..cecefd9c 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -25,7 +25,7 @@
    • ClusterPoolOptions
    +
  • Defined in src/pools/cluster/fixed.ts:11
    • @@ -56,7 +56,7 @@
    +
  • Defined in src/pools/pool.ts:97

    • Optional Experimental enableTasksQueue

    enableTasksQueue?: boolean
    @@ -66,7 +66,7 @@
    +
  • Defined in src/pools/pool.ts:104

    • Optional env

    env?: any
    @@ -75,7 +75,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>
    @@ -83,7 +83,7 @@
    +
  • Defined in src/pools/pool.ts:75

    • Optional exitHandler

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

    • Optional messageHandler

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

    • Optional onlineHandler

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

    • Optional settings

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

    See

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

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

    • Optional Experimental tasksQueueOptions

    tasksQueueOptions?: TasksQueueOptions
    @@ -124,7 +124,7 @@
    +
  • Defined in src/pools/pool.ts:110

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    @@ -132,7 +132,7 @@
    +
  • Defined in src/pools/pool.ts:87

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -140,7 +140,7 @@
    +
  • Defined in src/pools/pool.ts:91
    • diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index fa5693f5..3ff97450 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -42,7 +42,7 @@ +
  • Defined in src/pools/pool.ts:120
    • @@ -74,7 +74,7 @@

    Returns Promise<void>

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

    • Optional Readonly emitter

    emitter?: PoolEmitter
    @@ -86,7 +86,7 @@
    +
  • Defined in src/pools/pool.ts:143

    • execute

    execute: ((data: Data) => Promise<Response>)
    @@ -110,7 +110,7 @@

    Returns Promise<Response>

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

    • findFreeWorkerNodeKey

    findFreeWorkerNodeKey: (() => number)
    @@ -129,7 +129,7 @@

    Returns number

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

    • setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN") => void)
    @@ -151,7 +151,7 @@

    Returns void

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

    • Readonly type

    type: PoolType
    @@ -159,14 +159,14 @@

    If it is 'dynamic', it provides the max property.

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

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[]

    Pool worker nodes.

    +
  • Defined in src/pools/pool.ts:134
    • diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index df15f285..5a7b4ea5 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -23,7 +23,7 @@
    • IWorker
    +
  • Defined in src/pools/worker.ts:86
    • @@ -46,7 +46,7 @@

    Param

    The event listener.

    +
  • Defined in src/pools/worker.ts:93

    • once

    once: ((event: "exit", handler: ExitHandler<IWorker>) => void)
    @@ -72,7 +72,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:103
    • diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 4937606f..0aa704b3 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -23,7 +23,7 @@
    • IWorkerChoiceStrategy
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:65
    • @@ -52,7 +52,7 @@

    Returns number

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

    • remove

    remove: ((workerNodeKey: number) => boolean)
    @@ -74,14 +74,14 @@

    Returns boolean

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

    • Readonly requiredStatistics

    requiredStatistics: RequiredStatistics

    Required tasks usage statistics.

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

    • reset

    reset: (() => boolean)
    @@ -96,7 +96,7 @@

    Returns boolean

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:73
    • diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 739ae083..c5374b80 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -14,7 +14,7 @@ -

    Interface MessageValue<Data, MainWorker>

    +

    Interface MessageValue<Data, MainWorker>Internal

    Message object that is passed between main worker and worker.

    @@ -36,7 +36,7 @@ +
  • Defined in src/utility-types.ts:18
    • @@ -60,14 +60,14 @@
    +
  • Defined in src/pools/worker.ts:42

    • Optional Readonly error

    error?: string

    Error.

    +
  • Defined in src/utility-types.ts:29

    • Optional Readonly id

    id?: string
    @@ -75,14 +75,14 @@
    +
  • Defined in src/pools/worker.ts:46

    • Optional Readonly kill

    kill?: 1 | "SOFT" | "HARD"

    Kill code.

    +
  • Defined in src/utility-types.ts:25

    • Optional Readonly Internal parent

    parent?: MainWorker
    @@ -90,14 +90,14 @@

    Only for internal use.

    +
  • Defined in src/utility-types.ts:40

    • Optional Readonly runTime

    runTime?: number

    Runtime.

    +
  • Defined in src/utility-types.ts:33
    • diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index fc8c3f0d..eba03122 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -23,7 +23,7 @@

    • Worker extends IWorker

      -

      The worker type.

      +

      Type of worker.

    Hierarchy

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

    Default Value

    true

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

    • Optional Experimental enableTasksQueue

    enableTasksQueue?: boolean
    @@ -69,56 +69,56 @@

    Default Value

    false

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

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>

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

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

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>

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

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

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>

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

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

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>

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

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

    • Optional Experimental tasksQueueOptions

    tasksQueueOptions?: TasksQueueOptions

    Pool worker tasks queue options.

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

    • 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:87

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    +
  • Defined in src/pools/pool.ts:91
    • diff --git a/docs/interfaces/PromiseResponseWrapper.html b/docs/interfaces/PromiseResponseWrapper.html index 0f18fac8..2ce803eb 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -34,7 +34,7 @@
    • PromiseResponseWrapper
    +
  • Defined in src/utility-types.ts:50
    • @@ -67,7 +67,7 @@
    Optional reason: string

    Returns void

    +
  • Defined in src/utility-types.ts:61

    • Readonly resolve

    resolve: ((value: Response) => void)
    @@ -87,14 +87,14 @@
    value: Response

    Returns void

    +
  • Defined in src/utility-types.ts:57

    • Readonly worker

    worker: Worker

    The worker handling the execution.

    +
  • Defined in src/utility-types.ts:65
    • diff --git a/docs/interfaces/RequiredStatistics.html b/docs/interfaces/RequiredStatistics.html index cbb675aa..67b3c284 100644 --- a/docs/interfaces/RequiredStatistics.html +++ b/docs/interfaces/RequiredStatistics.html @@ -14,7 +14,7 @@ -

    Interface RequiredStatistics

    +

    Interface RequiredStatisticsInternal

    Pool worker tasks usage statistics requirements.

    @@ -23,7 +23,7 @@ +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:47
    • @@ -43,21 +43,21 @@

    Require tasks average run time.

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

    • medRunTime

    medRunTime: boolean

    Require tasks median run time.

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

    • runTime

    runTime: boolean

    Require tasks run time.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:51
    • diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index 38fa893f..f1456f6d 100644 --- a/docs/interfaces/Task.html +++ b/docs/interfaces/Task.html @@ -32,7 +32,7 @@ +
  • Defined in src/pools/worker.ts:38
    • @@ -51,14 +51,14 @@

    Input data that will be passed to the worker.

    +
  • Defined in src/pools/worker.ts:42

    • Optional Readonly id

    id?: string

    UUID of the message.

    +
  • Defined in src/pools/worker.ts:46
    • diff --git a/docs/interfaces/TasksQueueOptions.html b/docs/interfaces/TasksQueueOptions.html index 0016c0c5..31446f21 100644 --- a/docs/interfaces/TasksQueueOptions.html +++ b/docs/interfaces/TasksQueueOptions.html @@ -23,7 +23,7 @@
    • TasksQueueOptions
    +
  • Defined in src/pools/pool.ts:53
    • @@ -43,7 +43,7 @@

    Default Value

    1

    +
  • Defined in src/pools/pool.ts:59
    • diff --git a/docs/interfaces/TasksUsage.html b/docs/interfaces/TasksUsage.html index 929de14d..988e841a 100644 --- a/docs/interfaces/TasksUsage.html +++ b/docs/interfaces/TasksUsage.html @@ -23,7 +23,7 @@
    • TasksUsage
    +
  • Defined in src/pools/worker.ts:52
    • @@ -47,49 +47,49 @@

    Average tasks runtime.

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

    • error

    error: number

    Number of tasks errored.

    +
  • Defined in src/pools/worker.ts:80

    • medRunTime

    medRunTime: number

    Median tasks runtime.

    +
  • Defined in src/pools/worker.ts:76

    • run

    run: number

    Number of tasks executed.

    +
  • Defined in src/pools/worker.ts:56

    • runTime

    runTime: number

    Tasks runtime.

    +
  • Defined in src/pools/worker.ts:64

    • runTimeHistory

    runTimeHistory: CircularArray<number>

    Tasks runtime history.

    +
  • Defined in src/pools/worker.ts:68

    • running

    running: number

    Number of tasks running.

    +
  • Defined in src/pools/worker.ts:60
    • diff --git a/docs/interfaces/WorkerChoiceStrategyOptions.html b/docs/interfaces/WorkerChoiceStrategyOptions.html index 93d49465..336899be 100644 --- a/docs/interfaces/WorkerChoiceStrategyOptions.html +++ b/docs/interfaces/WorkerChoiceStrategyOptions.html @@ -23,7 +23,7 @@
    • WorkerChoiceStrategyOptions
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:35
    • @@ -41,7 +41,7 @@

    Use tasks median run time instead of average run time.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:39
    • diff --git a/docs/interfaces/WorkerNode.html b/docs/interfaces/WorkerNode.html index 5f2c7a82..faa2182a 100644 --- a/docs/interfaces/WorkerNode.html +++ b/docs/interfaces/WorkerNode.html @@ -34,7 +34,7 @@
    • WorkerNode
    +
  • Defined in src/pools/worker.ts:113
    • @@ -54,21 +54,21 @@

    Worker node tasks queue.

    +
  • Defined in src/pools/worker.ts:125

    • tasksUsage

    tasksUsage: TasksUsage

    Worker node tasks usage statistics.

    +
  • Defined in src/pools/worker.ts:121

    • Readonly worker

    worker: Worker

    Worker node worker.

    +
  • Defined in src/pools/worker.ts:117
    • diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index af381d08..4602b98d 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/Draft.html b/docs/types/Draft.html index 314cbb79..d4c2840d 100644 --- a/docs/types/Draft.html +++ b/docs/types/Draft.html @@ -24,7 +24,7 @@

  • T

    • +
  • Defined in src/utility-types.ts:9
    • diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index d6fc18f9..19f9de44 100644 --- a/docs/types/ErrorHandler.html +++ b/docs/types/ErrorHandler.html @@ -39,7 +39,7 @@
    e: Error

    Returns void

    +
  • Defined in src/pools/worker.ts:14
    • diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html index d2c555fa..9f13fbad 100644 --- a/docs/types/ExitHandler.html +++ b/docs/types/ExitHandler.html @@ -39,7 +39,7 @@
    code: number

    Returns void

    +
  • Defined in src/pools/worker.ts:27
    • diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html index 1f45c294..a530e97e 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 cb7b8228..c744eb69 100644 --- a/docs/types/MessageHandler.html +++ b/docs/types/MessageHandler.html @@ -39,7 +39,7 @@
    m: unknown

    Returns void

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

    Returns void

    +
  • Defined in src/pools/worker.ts:22
    • diff --git a/docs/types/PoolEvent.html b/docs/types/PoolEvent.html index 64b13b3f..9acd8b73 100644 --- a/docs/types/PoolEvent.html +++ b/docs/types/PoolEvent.html @@ -19,7 +19,7 @@

    Pool event.

    +
  • Defined in src/pools/pool.ts:48
    • diff --git a/docs/types/ThreadWorkerWithMessageChannel.html b/docs/types/ThreadWorkerWithMessageChannel.html index c918de1a..570bd4d1 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 edf82cb9..57e47b9e 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 cab7cc81..a3d5ad26 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/PoolEvents.html b/docs/variables/PoolEvents.html index d6298f74..d06405f8 100644 --- a/docs/variables/PoolEvents.html +++ b/docs/variables/PoolEvents.html @@ -19,7 +19,7 @@

    Enumeration of pool events.

    +
  • Defined in src/pools/pool.ts:40
    • diff --git a/docs/variables/WorkerChoiceStrategies.html b/docs/variables/WorkerChoiceStrategies.html index 99103339..59fef54b 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