From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 4 Jun 2023 14:13:24 +0000 (+0000) Subject: chore: generate documentation X-Git-Tag: v2.5.3~1 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=5decbf239157d04bdf38a642fe2757f565a8d466;p=poolifier.git chore: generate documentation --- diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index fefd8138..0fbaae35 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -45,7 +45,7 @@ +
  • Defined in src/pools/abstract-pool.ts:38
    • @@ -153,7 +153,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

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

    • Protected Readonly filePath

    filePath: string

    Path to the worker file.

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

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

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

    • Protected Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    Default to a round robin algorithm.

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

    • Readonly workerNodes

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

    • Accessors

    @@ -232,7 +232,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected Abstract maxSize

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

    • Protected Abstract minSize

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

    • Protected Abstract type

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

    • Protected Abstract worker

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

    • Methods

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

    Returns void

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

    • Protected Abstract afterWorkerSetup

    Returns void

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

    • Protected beforeTaskExecutionHook

    Returns void

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    • Private checkFilePath

    Returns void

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

    Returns void | Promise<void>

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    • Private getWorkerNodeKey

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

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

    • Protected Abstract registerWorkerMessageListener

    Returns void

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

    • Private removeWorkerNode

    Returns void

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

    • Protected Abstract sendToWorker

    Returns void

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Private setWorkerNode

    Returns void

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

    • Private setWorkerNodeTasksUsage

    Returns void

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

    • Protected setupHook

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

    • Private tasksQueueSize

    Returns number

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

    • Private updateRunTimeTasksUsage

    Returns void

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

    • Private updateWaitTimeTasksUsage

    Returns void

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:629
    • diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 2040352d..67fa900b 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -43,7 +43,7 @@
  • ClusterWorker
  • ThreadWorker
    • +
  • Defined in src/worker/abstract-worker.ts:29
    • @@ -125,7 +125,7 @@

    Returns AbstractWorker<MainWorker, Data, Response>

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

    • Properties

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

    Handler id of the aliveInterval worker alive check.

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

    • Protected Readonly isMain

    isMain: boolean

    Whether this is the main worker or not.

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

    • Protected lastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

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

    • Protected mainWorker

    mainWorker: undefined | null | MainWorker

    Reference to main worker.

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

    • Protected Readonly opts

    opts: WorkerOptions = ...

    Options for the worker.

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

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

    • Methods

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

    Returns void

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

    • Private checkTaskFunctions

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

    Returns void

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

    • Private checkWorkerOptions

    Returns void

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

    • emitDestroy

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

    • Private getTaskFunction

    Returns WorkerFunction<Data, Response>

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

    • Protected handleError

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

    • Protected messageListener

    Returns void

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

    • Protected runAsync

    Returns void

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

    • runInAsyncScope

    Returns void

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

    • Protected Abstract sendToMainWorker

    Returns void

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

    • 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:24
    • @@ -109,7 +109,7 @@ but the minimum number of workers will be guaranteed.

    Returns ClusterWorker<Data, Response>

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

    • Properties

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

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

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

    • Protected lastTaskTimestamp

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

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

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

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

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

    • Methods

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

    Returns void

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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • Protected sendToMainWorker

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

    • triggerAsyncId

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

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly max

    max: number

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

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -181,7 +181,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/fixed.ts:57

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -225,7 +225,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:47

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Protected type

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

    • Protected worker

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected registerWorkerMessageListener

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:629
    • diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index de2edc9d..521c972a 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:15
    • @@ -133,7 +133,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:27

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly max

    max: number

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

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -225,7 +225,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:47

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Protected type

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

    • Protected worker

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected registerWorkerMessageListener

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:629
    • diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 7cb87fa3..7d6dbf12 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:43
    • @@ -130,7 +130,7 @@

    Returns FixedClusterPool<Data, Response>

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

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -215,7 +215,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Protected type

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

    • Protected worker

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected registerWorkerMessageListener

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:629
    • diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index fe3cb171..a5f77512 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/thread/fixed.ts:34
    • @@ -130,7 +130,7 @@

    Returns FixedThreadPool<Data, Response>

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

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -215,7 +215,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Protected type

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

    • Protected worker

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected registerWorkerMessageListener

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:629
    • diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index f094ff27..a20d6ef2 100644 --- a/docs/classes/PoolEmitter.html +++ b/docs/classes/PoolEmitter.html @@ -25,7 +25,7 @@
    • PoolEmitter
    +
  • Defined in src/pools/pool.ts:50
    • diff --git a/docs/classes/Queue.html b/docs/classes/Queue.html index 0d3dfa78..b03b7bcc 100644 --- a/docs/classes/Queue.html +++ b/docs/classes/Queue.html @@ -30,7 +30,7 @@
    • Queue
    +
  • Defined in src/queue.ts:8
    • @@ -72,29 +72,29 @@

    T

    Returns Queue<T>

    +
  • Defined in src/queue.ts:14

    • Properties

    Private head

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

    • Private items

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

    • Private max

    max: number
    +
  • Defined in src/queue.ts:12

    • Private tail

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

    • Accessors

    @@ -107,7 +107,7 @@

    Returns number

    The maximum size of the queue.

    +
  • Defined in src/queue.ts:37

    • size

      @@ -118,7 +118,7 @@

      Returns number

      The size of the queue.

    +
  • Defined in src/queue.ts:27

    • Methods

    @@ -131,7 +131,7 @@

    Returns undefined | T

    The dequeued item or undefined if the queue is empty.

    +
  • Defined in src/queue.ts:59

    • enqueue

      @@ -149,7 +149,7 @@

      Returns number

      The new size of the queue.

    +
  • Defined in src/queue.ts:47

    • peek

      @@ -159,7 +159,7 @@

    Returns undefined | T

    +
  • Defined in src/queue.ts:75
    • diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index fe0a39bb..892ce85e 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:24
    • @@ -109,7 +109,7 @@ but the minimum number of workers will be guaranteed.

    Returns ThreadWorker<Data, Response>

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

    • Properties

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

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

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

    • Protected lastTaskTimestamp

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

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

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

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

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

    • Methods

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

    Returns void

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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • Protected sendToMainWorker

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

    • triggerAsyncId

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

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

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

    • Properties

    Private Readonly workerChoiceStrategies

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

    • Private workerChoiceStrategy

    workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

    The worker choice strategy.

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

    • Methods

    @@ -126,7 +126,7 @@

    Returns number

    The key of the worker node.

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

    • getRequiredStatistics

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

    • remove

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

    • setOptions

    Returns void

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

    • setWorkerChoiceStrategy

    Returns void

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

    • update

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:131
    • diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 4d3f048b..fdbc41ad 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -25,7 +25,7 @@
    • ClusterPoolOptions
    +
  • Defined in src/pools/cluster/fixed.ts:15
    • @@ -57,7 +57,7 @@
    +
  • Defined in src/pools/pool.ts:136

    • Optional enableTasksQueue

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

    • Optional env

    env?: any
    @@ -76,7 +76,7 @@

    See

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

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

    • Optional errorHandler

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

    • Optional exitHandler

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

    • Optional messageHandler

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

    • Optional onlineHandler

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

    • Optional restartWorkerOnError

    restartWorkerOnError?: boolean
    @@ -116,7 +116,7 @@
    +
  • Defined in src/pools/pool.ts:130

    • Optional settings

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

    See

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

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

    • Optional tasksQueueOptions

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

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    @@ -143,7 +143,7 @@
    +
  • Defined in src/pools/pool.ts:122

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -151,7 +151,7 @@
    +
  • Defined in src/pools/pool.ts:126
    • diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 0c22722b..93f46940 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -42,7 +42,7 @@ +
  • Defined in src/pools/pool.ts:156
    • @@ -76,7 +76,7 @@

    Returns Promise<void>

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

    • Optional Readonly emitter

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

    • enableTasksQueue

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

    Returns void

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

    • execute

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

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    • Readonly info

    info: PoolInfo

    Pool information.

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

    • setTasksQueueOptions

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

    Returns void

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

    • setWorkerChoiceStrategy

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

    Returns void

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

    • setWorkerChoiceStrategyOptions

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

    Returns void

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

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[]

    Pool worker nodes.

    +
  • Defined in src/pools/pool.ts:168
    • diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index 38fae6a6..c8779a03 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -23,7 +23,7 @@
    • IWorker
    +
  • Defined in src/pools/worker.ts:113
    • @@ -46,7 +46,7 @@

    Param

    The event handler.

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

    • once

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

    Returns void

    +
  • Defined in src/pools/worker.ts:130
    • diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 9a21cb50..b4bc073f 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:98
    • @@ -55,7 +55,7 @@

    Returns number

    The worker node key.

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

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

    • Readonly requiredStatistics

    requiredStatistics: RequiredStatistics

    Required tasks usage statistics.

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

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

    • setOptions

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

    Returns void

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

    • 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:114
    • diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 74a4a806..6f929b94 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -36,7 +36,7 @@
    • MessageValue
    +
  • Defined in src/utility-types.ts:20
    • @@ -64,21 +64,21 @@
    +
  • Defined in src/pools/worker.ts:47

    • Optional Readonly error

    error?: string

    Task error.

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

    • Optional Readonly errorData

    errorData?: unknown

    Task data triggering task error.

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

    • Optional Readonly id

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

    • Optional Readonly kill

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

    Kill code.

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

    • Optional Readonly name

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

    • Optional Readonly parent

    parent?: MainWorker

    Reference to main worker.

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

    • Optional Readonly runTime

    runTime?: number

    Runtime.

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

    • Optional Readonly submissionTimestamp

    submissionTimestamp?: number
    @@ -123,14 +123,14 @@
    +
  • Defined in src/pools/worker.ts:51

    • Optional Readonly waitTime

    waitTime?: number

    Wait time.

    +
  • Defined in src/utility-types.ts:43
    • diff --git a/docs/interfaces/PoolInfo.html b/docs/interfaces/PoolInfo.html index 9a5dc0ec..9f6ebee3 100644 --- a/docs/interfaces/PoolInfo.html +++ b/docs/interfaces/PoolInfo.html @@ -23,7 +23,7 @@
    • PoolInfo
    +
  • Defined in src/pools/pool.ts:70
    • @@ -48,52 +48,52 @@

    busyWorkerNodes

    busyWorkerNodes: number
    +
  • Defined in src/pools/pool.ts:77

    • idleWorkerNodes

    idleWorkerNodes: number
    +
  • Defined in src/pools/pool.ts:76

    • maxQueuedTasks

    maxQueuedTasks: number
    +
  • Defined in src/pools/pool.ts:80

    • maxSize

    maxSize: number
    +
  • Defined in src/pools/pool.ts:74

    • minSize

    minSize: number
    +
  • Defined in src/pools/pool.ts:73

    • queuedTasks

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

    • runningTasks

    runningTasks: number
    +
  • Defined in src/pools/pool.ts:78

    • type

    type: "fixed" | "dynamic"
    +
  • Defined in src/pools/pool.ts:71

    • worker

    worker: "cluster" | "thread"
    +
  • Defined in src/pools/pool.ts:72

    • workerNodes

    workerNodes: number
    +
  • Defined in src/pools/pool.ts:75
    • diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 447decf2..c01b93d1 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -32,7 +32,7 @@ +
  • Defined in src/pools/pool.ts:100
    • @@ -61,7 +61,7 @@

    Default Value

    true

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

    • Optional enableTasksQueue

    enableTasksQueue?: boolean
    @@ -70,49 +70,49 @@

    Default Value

    false

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

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>

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

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

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>

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

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

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>

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

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

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>

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

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

    • Optional restartWorkerOnError

    restartWorkerOnError?: boolean

    Restart worker on error.

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

    • Optional tasksQueueOptions

    tasksQueueOptions?: TasksQueueOptions

    Pool worker tasks queue options.

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

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    @@ -121,14 +121,14 @@

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN

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

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    +
  • Defined in src/pools/pool.ts:126
    • diff --git a/docs/interfaces/PromiseResponseWrapper.html b/docs/interfaces/PromiseResponseWrapper.html index 928d3a40..a4503576 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -34,7 +34,7 @@
    • PromiseResponseWrapper
    +
  • Defined in src/utility-types.ts:103
    • @@ -67,7 +67,7 @@
    Optional reason: string

    Returns void

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

    • Readonly resolve

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

    Returns void

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

    • Readonly worker

    worker: Worker

    The worker handling the execution.

    +
  • Defined in src/utility-types.ts:118
    • diff --git a/docs/interfaces/RequiredStatistics.html b/docs/interfaces/RequiredStatistics.html index 220a6e46..13f104a3 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:68
    • @@ -46,42 +46,42 @@

    Require tasks average runtime.

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

    • avgWaitTime

    avgWaitTime: boolean

    Require tasks average wait time.

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

    • medRunTime

    medRunTime: boolean

    Require tasks median runtime.

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

    • medWaitTime

    medWaitTime: boolean

    Require tasks median wait time.

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

    • runTime

    runTime: boolean

    Require tasks runtime.

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

    • waitTime

    waitTime: boolean

    Require tasks wait time.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:84
    • diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index 942a16f4..4e864fa1 100644 --- a/docs/interfaces/Task.html +++ b/docs/interfaces/Task.html @@ -32,7 +32,7 @@ +
  • Defined in src/pools/worker.ts:39
    • @@ -53,28 +53,28 @@

    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:55

    • Optional Readonly name

    name?: string

    Task name.

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

    • Optional Readonly submissionTimestamp

    submissionTimestamp?: number

    Submission timestamp.

    +
  • Defined in src/pools/worker.ts:51
    • diff --git a/docs/interfaces/TasksQueueOptions.html b/docs/interfaces/TasksQueueOptions.html index 65a8705b..a911e177 100644 --- a/docs/interfaces/TasksQueueOptions.html +++ b/docs/interfaces/TasksQueueOptions.html @@ -23,7 +23,7 @@
    • TasksQueueOptions
    +
  • Defined in src/pools/pool.ts:86
    • @@ -43,7 +43,7 @@

    Default Value

    1

    +
  • Defined in src/pools/pool.ts:92
    • diff --git a/docs/interfaces/TasksUsage.html b/docs/interfaces/TasksUsage.html index 5d5897c7..45029642 100644 --- a/docs/interfaces/TasksUsage.html +++ b/docs/interfaces/TasksUsage.html @@ -23,7 +23,7 @@
    • TasksUsage
    +
  • Defined in src/pools/worker.ts:63
    • @@ -51,77 +51,77 @@

    Average tasks runtime.

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

    • avgWaitTime

    avgWaitTime: number

    Average tasks wait time.

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

    • error

    error: number

    Number of tasks errored.

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

    • medRunTime

    medRunTime: number

    Median tasks runtime.

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

    • medWaitTime

    medWaitTime: number

    Median tasks wait time.

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

    • run

    run: number

    Number of tasks executed.

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

    • runTime

    runTime: number

    Tasks runtime.

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

    • runTimeHistory

    runTimeHistory: CircularArray<number>

    Tasks runtime history.

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

    • running

    running: number

    Number of tasks running.

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

    • waitTime

    waitTime: number

    Tasks wait time.

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

    • waitTimeHistory

    waitTimeHistory: CircularArray<number>

    Tasks wait time history.

    +
  • Defined in src/pools/worker.ts:95
    • diff --git a/docs/interfaces/WorkerChoiceStrategyOptions.html b/docs/interfaces/WorkerChoiceStrategyOptions.html index d974b459..c00de26b 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:41
    • @@ -45,7 +45,7 @@

    Default Value

    false

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

    • Optional medWaitTime

    medWaitTime?: boolean
    @@ -54,7 +54,7 @@

    Default Value

    false

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

    • Optional weights

    weights?: Record<number, number>
    @@ -64,7 +64,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:60
    • diff --git a/docs/interfaces/WorkerNode.html b/docs/interfaces/WorkerNode.html index 2f5f8365..ff03c91a 100644 --- a/docs/interfaces/WorkerNode.html +++ b/docs/interfaces/WorkerNode.html @@ -34,7 +34,7 @@
    • WorkerNode
    +
  • Defined in src/pools/worker.ts:140
    • @@ -54,21 +54,21 @@

    Worker node tasks queue.

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

    • tasksUsage

    tasksUsage: TasksUsage

    Worker node tasks usage statistics.

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

    • Readonly worker

    worker: Worker

    Worker node worker.

    +
  • Defined in src/pools/worker.ts:144
    • diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 537db4a2..6e69b4a6 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 9edf4e97..3109b3ca 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 18591091..14879b79 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 2eb2fc09..8aa84bea 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 6aafd2e6..40b57837 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 6479b7ea..2e534893 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 21956c10..98cd2009 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 f0348a4a..8139df13 100644 --- a/docs/types/PoolEvent.html +++ b/docs/types/PoolEvent.html @@ -19,7 +19,7 @@

    Pool event.

    +
  • Defined in src/pools/pool.ts:65
    • diff --git a/docs/types/PoolType.html b/docs/types/PoolType.html index 8b1d41ef..bdcc5cc4 100644 --- a/docs/types/PoolType.html +++ b/docs/types/PoolType.html @@ -19,7 +19,7 @@

    Pool type.

    +
  • Defined in src/pools/pool.ts:32
    • diff --git a/docs/types/TaskFunctions.html b/docs/types/TaskFunctions.html index 6319c918..80b39932 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:91
    • diff --git a/docs/types/ThreadWorkerWithMessageChannel.html b/docs/types/ThreadWorkerWithMessageChannel.html index 24889e2f..a9f08704 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:20
    • diff --git a/docs/types/WorkerAsyncFunction.html b/docs/types/WorkerAsyncFunction.html index 2df30570..bb5148a4 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:67
    • diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index 8282f09e..cf0a2770 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:36
    • diff --git a/docs/types/WorkerFunction.html b/docs/types/WorkerFunction.html index ccf78544..0bd1266c 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:78
    • diff --git a/docs/types/WorkerSyncFunction.html b/docs/types/WorkerSyncFunction.html index 6be129e1..5500654d 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:56
    • diff --git a/docs/types/WorkerType.html b/docs/types/WorkerType.html index efee39e6..fcbb15df 100644 --- a/docs/types/WorkerType.html +++ b/docs/types/WorkerType.html @@ -19,7 +19,7 @@

    Worker type.

    +
  • Defined in src/pools/pool.ts:45
    • diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html index d0d6f9d7..33f28de9 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 f97afe3b..a8287d08 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:55
    • diff --git a/docs/variables/PoolTypes.html b/docs/variables/PoolTypes.html index f4eba8ac..eef14c4f 100644 --- a/docs/variables/PoolTypes.html +++ b/docs/variables/PoolTypes.html @@ -19,7 +19,7 @@

    Enumeration of pool types.

    +
  • Defined in src/pools/pool.ts:18
    • diff --git a/docs/variables/WorkerChoiceStrategies.html b/docs/variables/WorkerChoiceStrategies.html index cc0c4481..46eeec48 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
    • diff --git a/docs/variables/WorkerTypes.html b/docs/variables/WorkerTypes.html index bbbc3207..6ac350e3 100644 --- a/docs/variables/WorkerTypes.html +++ b/docs/variables/WorkerTypes.html @@ -19,7 +19,7 @@

    Enumeration of worker types.

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