From 73d8141b526469f4fce46da956280f2b9146accb Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 7 May 2023 21:40:33 +0000 Subject: [PATCH] chore: generate documentation --- docs/classes/AbstractPool.html | 106 +++++++++--------- docs/classes/AbstractWorker.html | 36 +++--- docs/classes/CircularArray.html | 22 ++-- docs/classes/ClusterWorker.html | 30 ++--- docs/classes/DynamicClusterPool.html | 70 ++++++------ docs/classes/DynamicThreadPool.html | 70 ++++++------ docs/classes/FixedClusterPool.html | 68 +++++------ docs/classes/FixedThreadPool.html | 68 +++++------ docs/classes/PoolEmitter.html | 2 +- docs/classes/Queue.html | 16 +-- docs/classes/ThreadWorker.html | 30 ++--- docs/classes/WorkerChoiceStrategyContext.html | 22 ++-- docs/enums/PoolType.html | 6 +- docs/interfaces/ClusterPoolOptions.html | 24 ++-- docs/interfaces/IPool.html | 22 ++-- docs/interfaces/IWorker.html | 6 +- docs/interfaces/IWorkerChoiceStrategy.html | 14 +-- docs/interfaces/MessageValue.html | 16 +-- docs/interfaces/PoolOptions.html | 20 ++-- docs/interfaces/PromiseResponseWrapper.html | 8 +- docs/interfaces/RequiredStatistics.html | 8 +- docs/interfaces/Task.html | 8 +- docs/interfaces/TasksQueueOptions.html | 4 +- docs/interfaces/TasksUsage.html | 16 +-- .../WorkerChoiceStrategyOptions.html | 6 +- 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 +- docs/types/TaskFunctions.html | 2 +- .../types/ThreadWorkerWithMessageChannel.html | 2 +- docs/types/WorkerAsyncFunction.html | 2 +- docs/types/WorkerChoiceStrategy.html | 2 +- docs/types/WorkerFunction.html | 2 +- docs/types/WorkerSyncFunction.html | 2 +- docs/variables/KillBehaviors.html | 2 +- docs/variables/PoolEvents.html | 2 +- docs/variables/WorkerChoiceStrategies.html | 2 +- 43 files changed, 373 insertions(+), 373 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index c2a8b6536..82bdaf53d 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -45,7 +45,7 @@ +
  • Defined in src/pools/abstract-pool.ts:35
    • @@ -150,7 +150,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

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

    • Readonly filePath

    filePath: string

    Path to the worker file.

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

    • Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

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

    • Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

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

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -198,7 +198,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:54

    • Protected workerChoiceStrategyContext

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

    Default to a round robin algorithm.

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

    • Readonly workerNodes

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

    • Accessors

    @@ -227,7 +227,7 @@

    Returns boolean

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

    • Protected Abstract full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • Abstract size

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

    • Abstract type

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

    • Methods

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

    Returns void

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

    • Protected Abstract afterWorkerSetup

    Returns void

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

    • Protected beforeTaskExecutionHook

    Returns void

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    • Private checkFilePath

    Returns void

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

    Returns void | Promise<void>

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    • Private getWorkerNodeKey

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

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

    • Protected Abstract registerWorkerMessageListener

    Returns void

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

    • Private removeWorkerNode

    Returns void

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

    • Protected Abstract sendToWorker

    Returns void

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Private setWorkerNode

    Returns void

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

    • Private setWorkerNodeTasksUsage

    Returns void

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

    • Protected setupHook

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

    • Private tasksQueueSize

    Returns number

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:532
    • diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index e08adc259..43170e02b 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -43,7 +43,7 @@
  • ClusterWorker
  • ThreadWorker
    • +
  • Defined in src/worker/abstract-worker.ts:26
    • @@ -125,7 +125,7 @@

    Returns AbstractWorker<MainWorker, Data, Response>

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

    • Properties

    @@ -134,42 +134,42 @@

    Handler id of the aliveInterval worker alive check.

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

    • Protected Readonly isMain

    isMain: boolean

    Whether this is the main worker or not.

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

    • Protected lastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

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

    • Protected mainWorker

    mainWorker: undefined | null | MainWorker

    Reference to main worker.

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

    • Protected Readonly opts

    opts: WorkerOptions = ...

    Options for the worker.

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

    • Protected taskFunctions

    taskFunctions: Map<string, WorkerFunction<Data, Response>>

    Task function(s) processed by the worker when the pool's execution function is invoked.

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

    • Methods

    @@ -217,7 +217,7 @@

    Returns void

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

    • Private checkTaskFunctions

      @@ -234,7 +234,7 @@

    Returns void

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

    • Private checkWorkerOptions

    Returns void

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

    • emitDestroy

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

    • Private getTaskFunction

    Returns WorkerFunction<Data, Response>

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

    • Protected handleError

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

    • Protected messageListener

    Returns void

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

    • Protected runAsync

    Returns void

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

    • runInAsyncScope

    Returns void

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

    • Protected Abstract sendToMainWorker

    Returns void

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

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

    • concat

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

    • copyWithin

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

    • entries

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

    • includes

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

    • reduce

    Returns void

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

    • reverse

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

    • toLocaleString

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

    • values

    +
  • Defined in src/worker/cluster-worker.ts:25
    • @@ -109,7 +109,7 @@ but the minimum number of workers will be guaranteed.

    Returns ClusterWorker<Data, Response>

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

    • Properties

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

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

    • Protected Readonly isMain

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

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

    • Protected lastTaskTimestamp

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

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

    • Protected mainWorker

    mainWorker: undefined | null | Worker
    @@ -143,7 +143,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected Readonly opts

    opts: WorkerOptions = ...
    @@ -151,7 +151,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected taskFunctions

    taskFunctions: Map<string, WorkerFunction<Data, Response>>
    @@ -159,7 +159,7 @@ but the minimum number of workers will be guaranteed.

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

    • Methods

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

    Returns void

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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • Protected sendToMainWorker

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

    • triggerAsyncId

    +
  • Defined in src/pools/cluster/dynamic.ts:16
    • @@ -132,7 +132,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

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

    • Readonly filePath

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

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

    • Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -178,7 +178,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>> = ...
    @@ -191,7 +191,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:54

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -222,7 +222,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:53

    • Protected full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • size

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • 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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:532
    • diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index ff4aac3f5..0c01dcd06 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
    • @@ -132,7 +132,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

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

    • Readonly filePath

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

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

    • Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -222,7 +222,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:54

    • Protected full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • size

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • 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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:532
    • diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index cda595b96..d8c24d715 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:39
    • @@ -129,7 +129,7 @@

    Returns FixedClusterPool<Data, Response>

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

    • Properties

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

    • Readonly filePath

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

    • Readonly numberOfWorkers

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

    • Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -212,7 +212,7 @@

    Returns boolean

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

    • Protected full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • size

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • 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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:532
    • diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 5e13b384c..f6b1800ce 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/thread/fixed.ts:29
    • @@ -129,7 +129,7 @@

    Returns FixedThreadPool<Data, Response>

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

    • Properties

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

    • Readonly filePath

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

    • Readonly numberOfWorkers

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

    • Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -212,7 +212,7 @@

    Returns boolean

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

    • Protected full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • size

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • 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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:532
    • diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index af82c68f0..07d910b76 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/Queue.html b/docs/classes/Queue.html index bf6612cfb..0f248f1fc 100644 --- a/docs/classes/Queue.html +++ b/docs/classes/Queue.html @@ -30,7 +30,7 @@
    • Queue
    +
  • Defined in src/queue.ts:8
    • @@ -69,24 +69,24 @@

    T

    Returns Queue<T>

    +
  • Defined in src/queue.ts:13

    • Properties

    Private head

    head: number
    +
  • Defined in src/queue.ts:10

    • Private items

    items: Record<number, T>
    +
  • Defined in src/queue.ts:9

    • Private tail

    tail: number
    +
  • Defined in src/queue.ts:11

    • Accessors

    @@ -99,7 +99,7 @@

    Returns number

    The size of the queue.

    +
  • Defined in src/queue.ts:25

    • Methods

    @@ -112,7 +112,7 @@

    Returns undefined | T

    The dequeued item or undefined if the queue is empty.

    +
  • Defined in src/queue.ts:46

    • enqueue

      @@ -130,7 +130,7 @@

      Returns number

      The new size of the queue.

    +
  • Defined in src/queue.ts:35
    • diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index d01d5473f..62198283e 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:25
    • @@ -109,7 +109,7 @@ but the minimum number of workers will be guaranteed.

    Returns ThreadWorker<Data, Response>

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

    • Properties

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

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

    • Protected Readonly isMain

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

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

    • Protected lastTaskTimestamp

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

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

    • Protected mainWorker

    mainWorker: undefined | null | MessagePort
    @@ -143,7 +143,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected Readonly opts

    opts: WorkerOptions = ...
    @@ -151,7 +151,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected taskFunctions

    taskFunctions: Map<string, WorkerFunction<Data, Response>>
    @@ -159,7 +159,7 @@ but the minimum number of workers will be guaranteed.

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

    • Methods

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

    Returns void

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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • Protected sendToMainWorker

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

    • triggerAsyncId

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:24
    • @@ -97,21 +97,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 workerChoiceStrategy

    workerChoiceStrategy: "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

    @@ -121,12 +121,12 @@

  • Executes the worker choice strategy algorithm in the context.

    -

    Throws

    @node/api/errors.html#class-error If the worker node key is null or undefined.

    +

    Throws

    https://nodejs.org/api/errors.html#class-error If the worker node key is null or undefined.

    Returns number

    The key of the worker node.

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

    • getRequiredStatistics

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

    • remove

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

    • setOptions

    Returns void

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

    • setWorkerChoiceStrategy

    Returns void

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

    • update

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:122
    • diff --git a/docs/enums/PoolType.html b/docs/enums/PoolType.html index 67df0aa54..d826c35d2 100644 --- a/docs/enums/PoolType.html +++ b/docs/enums/PoolType.html @@ -19,7 +19,7 @@

    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 123350c53..f6bb82dcd 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:99

    • Optional enableTasksQueue

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

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

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

    • Optional workerChoiceStrategy

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

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -142,7 +142,7 @@
    +
  • Defined in src/pools/pool.ts:93
    • diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 96b35a064..133c677fb 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -42,7 +42,7 @@ +
  • Defined in src/pools/pool.ts:119
    • @@ -77,7 +77,7 @@

    Returns Promise<void>

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

    • Optional Readonly emitter

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

    • enableTasksQueue

    enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -115,7 +115,7 @@

    Returns void

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

    • execute

    execute: ((data?, name?) => Promise<Response>)
    @@ -142,7 +142,7 @@

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    • setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -164,7 +164,7 @@

    Returns void

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

    • setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -190,7 +190,7 @@

    Returns void

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

    • setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -212,14 +212,14 @@

    Returns void

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

    • Readonly size

    size: number

    Pool maximum size.

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

    • Readonly type

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

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

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

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[]

    Pool worker nodes.

    +
  • Defined in src/pools/pool.ts:137
    • diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index def9e9fd2..23a612a87 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -23,7 +23,7 @@
    • IWorker
    +
  • Defined in src/pools/worker.ts:93
    • @@ -46,7 +46,7 @@

    Param

    The event handler.

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

    • once

    once: ((event, handler) => void)
    @@ -72,7 +72,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:110
    • diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 559ff9ec5..34adb5eb7 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:74
    • @@ -55,7 +55,7 @@

    Returns number

    The worker node key.

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

    • remove

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

    Returns boolean

    true if the worker node key is removed, false otherwise.

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

    • Readonly requiredStatistics

    requiredStatistics: RequiredStatistics

    Required tasks usage statistics.

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

    • reset

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

    Returns boolean

    true if the reset is successful, false otherwise.

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

    • setOptions

    setOptions: ((opts) => void)
    @@ -123,7 +123,7 @@

    Returns void

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

    • update

    update: ((workerNodeKey) => boolean)
    @@ -144,7 +144,7 @@

    Returns boolean

    true if the update is successful, false otherwise.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:90
    • diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index e84618fe3..f23a59ea3 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -36,7 +36,7 @@
    • MessageValue
    +
  • Defined in src/utility-types.ts:20
    • @@ -61,14 +61,14 @@
    +
  • Defined in src/pools/worker.ts:47

    • Optional Readonly error

    error?: string

    Error.

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

    • Optional Readonly id

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

    • Optional Readonly kill

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

    Kill code.

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

    • Optional Readonly name

    name?: string
    @@ -91,21 +91,21 @@
    +
  • Defined in src/pools/worker.ts:43

    • Optional Readonly parent

    parent?: MainWorker

    Reference to main worker.

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

    • Optional Readonly runTime

    runTime?: number

    Runtime.

    +
  • Defined in src/utility-types.ts:35
    • diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index dd56481b9..acfa4b06b 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -32,7 +32,7 @@ +
  • Defined in src/pools/pool.ts:67
    • @@ -60,7 +60,7 @@

    Default Value

    true

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

    • Optional enableTasksQueue

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

    Default Value

    false

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

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

    tasksQueueOptions?: TasksQueueOptions

    Pool worker tasks queue options.

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

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    @@ -113,14 +113,14 @@

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN

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

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    +
  • Defined in src/pools/pool.ts:93
    • diff --git a/docs/interfaces/PromiseResponseWrapper.html b/docs/interfaces/PromiseResponseWrapper.html index fd14c5ba8..049a716f4 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -34,7 +34,7 @@
    • PromiseResponseWrapper
    +
  • Defined in src/utility-types.ts:95
    • @@ -67,7 +67,7 @@
    Optional reason: string

    Returns void

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

    • Readonly resolve

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

    Returns void

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

    • Readonly worker

    worker: Worker

    The worker handling the execution.

    +
  • Defined in src/utility-types.ts:110
    • diff --git a/docs/interfaces/RequiredStatistics.html b/docs/interfaces/RequiredStatistics.html index dd9640d37..a7091aa68 100644 --- a/docs/interfaces/RequiredStatistics.html +++ b/docs/interfaces/RequiredStatistics.html @@ -23,7 +23,7 @@
    • RequiredStatistics
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:56
    • @@ -43,21 +43,21 @@

    Require tasks average run time.

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

    • medRunTime

    medRunTime: boolean

    Require tasks median run time.

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

    • runTime

    runTime: boolean

    Require tasks run time.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:60
    • diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index eda240ed6..cc5b6450d 100644 --- a/docs/interfaces/Task.html +++ b/docs/interfaces/Task.html @@ -32,7 +32,7 @@ +
  • Defined in src/pools/worker.ts:39
    • @@ -52,21 +52,21 @@

    Task input data that will be passed to the worker.

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

    • Optional Readonly id

    id?: string

    Message UUID.

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

    • Optional Readonly name

    name?: string

    Task name.

    +
  • Defined in src/pools/worker.ts:43
    • diff --git a/docs/interfaces/TasksQueueOptions.html b/docs/interfaces/TasksQueueOptions.html index c790fa36d..774680684 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 6c3fa4774..4809543cd 100644 --- a/docs/interfaces/TasksUsage.html +++ b/docs/interfaces/TasksUsage.html @@ -23,7 +23,7 @@
    • TasksUsage
    +
  • Defined in src/pools/worker.ts:59
    • @@ -47,49 +47,49 @@

    Average tasks runtime.

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

    • error

    error: number

    Number of tasks errored.

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

    • medRunTime

    medRunTime: number

    Median tasks runtime.

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

    • run

    run: number

    Number of tasks executed.

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

    • runTime

    runTime: number

    Tasks runtime.

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

    • runTimeHistory

    runTimeHistory: CircularArray<number>

    Tasks runtime history.

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

    • running

    running: number

    Number of tasks running.

    +
  • Defined in src/pools/worker.ts:67
    • diff --git a/docs/interfaces/WorkerChoiceStrategyOptions.html b/docs/interfaces/WorkerChoiceStrategyOptions.html index 5eef21b4f..83ec3f4cb 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
    • @@ -44,7 +44,7 @@

    Default Value

    false

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

    • Optional weights

    weights?: Record<number, number>
    @@ -54,7 +54,7 @@ Weight is the tasks maximum average or median runtime in milliseconds.

    Default Value

    Computed worker weights automatically given the CPU performance.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:48
    • diff --git a/docs/interfaces/WorkerNode.html b/docs/interfaces/WorkerNode.html index 29ade44f8..ef41523dc 100644 --- a/docs/interfaces/WorkerNode.html +++ b/docs/interfaces/WorkerNode.html @@ -34,7 +34,7 @@
    • WorkerNode
    +
  • Defined in src/pools/worker.ts:120
    • @@ -54,21 +54,21 @@

    Worker node tasks queue.

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

    • tasksUsage

    tasksUsage: TasksUsage

    Worker node tasks usage statistics.

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

    • Readonly worker

    worker: Worker

    Worker node worker.

    +
  • Defined in src/pools/worker.ts:124
    • diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 1d3e8a409..e9a7198c3 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -23,7 +23,7 @@
    • WorkerOptions
    +
  • Defined in src/worker/worker-options.ts:38
    • @@ -47,7 +47,7 @@

    Deprecated

    This option will be removed in the next major version.

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

    • Optional killBehavior

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

    Default Value

    KillBehaviors.SOFT

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

    • Optional maxInactiveTime

    maxInactiveTime?: number
    @@ -77,7 +77,7 @@ when this timeout expires your tasks is interrupted and the worker is killed if

    Default Value

    60000

    +
  • Defined in src/worker/worker-options.ts:51
    • diff --git a/docs/types/Draft.html b/docs/types/Draft.html index 5dca7e95d..f918e94cd 100644 --- a/docs/types/Draft.html +++ b/docs/types/Draft.html @@ -26,7 +26,7 @@

    Type in which properties will be non-readonly.

    +
  • Defined in src/utility-types.ts:11
    • diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index f10ecad6a..a853af148 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:15
    • diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html index 8a2be9eb7..22cbb133a 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:28
    • diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html index 75708f46a..a1a68f961 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 a0817b9a0..6be8c2547 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:7
    • diff --git a/docs/types/OnlineHandler.html b/docs/types/OnlineHandler.html index 95094f702..dedba75a0 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:23
    • diff --git a/docs/types/PoolEvent.html b/docs/types/PoolEvent.html index 1bf1daf96..49c4a543b 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/TaskFunctions.html b/docs/types/TaskFunctions.html index ca3d5d303..6745a7116 100644 --- a/docs/types/TaskFunctions.html +++ b/docs/types/TaskFunctions.html @@ -33,7 +33,7 @@ The value is the function itself.

    Type of execution response. This can only be serializable data.

    +
  • Defined in src/utility-types.ts:83
    • diff --git a/docs/types/ThreadWorkerWithMessageChannel.html b/docs/types/ThreadWorkerWithMessageChannel.html index 6a3099576..5be768026 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/WorkerAsyncFunction.html b/docs/types/WorkerAsyncFunction.html index b1829b70f..424814e03 100644 --- a/docs/types/WorkerAsyncFunction.html +++ b/docs/types/WorkerAsyncFunction.html @@ -44,7 +44,7 @@ This function must return a promise.

    Optional data: Data

    Returns Promise<Response>

    +
  • Defined in src/utility-types.ts:59
    • diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index af5ceb14f..c5078fa24 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/types/WorkerFunction.html b/docs/types/WorkerFunction.html index e7df21693..d74de516e 100644 --- a/docs/types/WorkerFunction.html +++ b/docs/types/WorkerFunction.html @@ -31,7 +31,7 @@ This function can be synchronous or asynchronous.

    Type of execution response. This can only be serializable data.

    +
  • Defined in src/utility-types.ts:70
    • diff --git a/docs/types/WorkerSyncFunction.html b/docs/types/WorkerSyncFunction.html index 98bdf9aa1..c703ba903 100644 --- a/docs/types/WorkerSyncFunction.html +++ b/docs/types/WorkerSyncFunction.html @@ -43,7 +43,7 @@
    Optional data: Data

    Returns Response

    +
  • Defined in src/utility-types.ts:48
    • diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html index 4de4dd297..0a8f0d65f 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 95eaee4dd..cb0a16af4 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 196825755..ab7c38d7c 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.43.0