From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 15 Apr 2023 17:13:41 +0000 (+0000) Subject: chore: generate documentation X-Git-Tag: v2.4.10~9^2 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=9954c636f2caafac0b2bf0289059788679fd3053;p=poolifier.git chore: generate documentation --- diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 665bed64..5a10ce60 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -45,7 +45,7 @@ +
  • Defined in src/pools/abstract-pool.ts:33
    • @@ -151,7 +151,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

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

    • Readonly filePath

    filePath: string

    Path to the worker file.

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

    • Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

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

    • Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    Default to a round robin algorithm.

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

    • Readonly workerNodes

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

    • Accessors

    @@ -228,7 +228,7 @@

    Returns boolean

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

    • Protected Abstract full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • Abstract type

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

    • Methods

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

    Returns void

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

    • Protected Abstract afterWorkerSetup

    Returns void

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

    • Protected beforeTaskExecutionHook

    Returns void

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    • Private checkFilePath

    Returns void

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

    Returns void | Promise<void>

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • findFreeWorkerNodeKey

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueueByWorker

    Returns void

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

    • Private flushTasksQueues

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

    • Private getWorkerNodeKey

    Returns number

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

    • Private getWorkerTasksUsage

    Returns undefined | TasksUsage

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

    Returns number

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

    • Protected Abstract registerWorkerMessageListener

    Returns void

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

    • Private removeWorkerNode

    Returns void

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

    • Protected Abstract sendToWorker

    Returns void

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Private setWorkerNode

    Returns void

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

    • Private setWorkerNodeTasksUsage

    Returns void

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

    • Protected setupHook

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

    • Private tasksQueueSize

    Returns number

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

    • Protected workerListener

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:507
    • diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 54dc5485..6c2de6b9 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -43,7 +43,7 @@
  • ClusterWorker
  • ThreadWorker
    • +
  • Defined in src/worker/abstract-worker.ts:24
    • @@ -123,7 +123,7 @@

    Returns AbstractWorker<MainWorker, Data, Response>

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

    • Properties

    @@ -132,35 +132,35 @@

    Handler id of the aliveInterval worker alive check.

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

    • Protected Readonly isMain

    isMain: boolean

    Whether this is the main worker or not.

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

    • Protected lastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

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

    • Protected mainWorker

    mainWorker: undefined | null | MainWorker

    Reference to main worker.

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

    • Protected Readonly opts

    opts: WorkerOptions = ...

    Options for the worker.

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

    • Methods

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

    Returns void

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

    • Private checkFunctionInput

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

    Returns void

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

    • Private checkWorkerOptions

    Returns void

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

    • emitDestroy

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

    • Protected handleError

    Returns string

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

    • Protected messageListener

    Returns void

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

    • Protected run

    Returns void

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

    • Protected runAsync

    Returns void

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

    • runInAsyncScope

    Returns void

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

    • triggerAsyncId

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

    Returns CircularArray<T>

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

    • Properties

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

    size

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

    • Static Readonly [species]

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

    • concat

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

    • copyWithin

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

    • entries

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

    • includes

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

    • reduce

    Returns void

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

    • reverse

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

    • toLocaleString

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

    • values

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

    Returns ClusterWorker<Data, Response>

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

    • Properties

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

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

    • Protected Readonly isMain

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

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

    • Protected lastTaskTimestamp

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

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

    • Protected mainWorker

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

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

    • Protected Readonly opts

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

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

    • Methods

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

    Returns void

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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

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

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

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

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

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

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

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

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

    • Protected full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • findFreeWorkerNodeKey

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

    • Protected internalBusy

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

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:507
    • diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 18d49587..a98ae60f 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:42

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

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

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

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

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

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

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

    • Protected full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • findFreeWorkerNodeKey

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

    • Protected internalBusy

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

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:507
    • diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 2955f106..08a99fd5 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:42

    • Readonly filePath

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

    • Readonly numberOfWorkers

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

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

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

    Returns boolean

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

    • Protected full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • findFreeWorkerNodeKey

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

    • Protected internalBusy

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

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:507
    • diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 72a84a25..1a0098ff 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:42

    • Readonly filePath

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

    • Readonly numberOfWorkers

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

    • Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

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

    Returns boolean

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

    • Protected full

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

    • Private numberOfQueuedTasks

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

    • Private numberOfRunningTasks

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

    • type

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • findFreeWorkerNodeKey

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

    • Protected internalBusy

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

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:507
    • diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index ac882ee5..2503c416 100644 --- a/docs/classes/PoolEmitter.html +++ b/docs/classes/PoolEmitter.html @@ -25,7 +25,7 @@
    • PoolEmitter
    +
  • Defined in src/pools/pool.ts:35
    • diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 030c1b5f..3cb7b096 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -44,7 +44,7 @@ but the minimum number of workers will be guaranteed.

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

    Returns ThreadWorker<Data, Response>

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

    • Properties

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

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

    • Protected Readonly isMain

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

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

    • Protected lastTaskTimestamp

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

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

    • Protected mainWorker

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

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

    • Protected Readonly opts

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

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

    • Methods

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

    Returns void

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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • triggerAsyncId

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

    @@ -124,7 +124,7 @@

    Returns number

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

    • getRequiredStatistics

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

    • remove

    Returns boolean

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

    • setOptions

    Returns void

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

    • setWorkerChoiceStrategy

    Returns void

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:95
    • diff --git a/docs/enums/PoolType.html b/docs/enums/PoolType.html index 7a02f51d..db78ed66 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 109004e9..7be33ba2 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 e4700764..e0c80130 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:163

    • Optional Readonly emitter

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

    • enableTasksQueue

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

    Returns void

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

    • execute

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

    Returns Promise<Response>

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

    • findFreeWorkerNodeKey

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

    Returns number

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

    • setTasksQueueOptions

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

    Returns void

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

    • setWorkerChoiceStrategy

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

    Returns void

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

    • setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions: WorkerChoiceStrategyOptions) => void)
    @@ -228,7 +228,7 @@

    Returns void

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

    • Readonly type

    type: PoolType
    @@ -236,14 +236,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:133
    • diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index df0c15ab..ecd2df27 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -23,7 +23,7 @@
    • IWorker
    +
  • Defined in src/pools/worker.ts:88
    • @@ -46,7 +46,7 @@

    Param

    The event handler.

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

    • once

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

    Returns void

    +
  • Defined in src/pools/worker.ts:105
    • diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index d02e3926..8d8978e7 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:67
    • @@ -53,7 +53,7 @@

    Returns number

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

    • remove

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

    Returns boolean

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

    • Readonly requiredStatistics

    requiredStatistics: RequiredStatistics

    Required tasks usage statistics.

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

    • reset

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

    Returns boolean

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

    • setOptions

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

    Returns void

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:91
    • diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index c2de7217..7f6d59ce 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -36,7 +36,7 @@
    • MessageValue
    +
  • Defined in src/utility-types.ts:20
    • @@ -60,14 +60,14 @@
    +
  • Defined in src/pools/worker.ts:42

    • Optional Readonly error

    error?: string

    Error.

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

    • Optional Readonly id

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

    • Optional Readonly kill

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

    Kill code.

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

    • 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 9332efd4..5aa9eb04 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 b8d03178..7cb4709b 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -34,7 +34,7 @@
    • PromiseResponseWrapper
    +
  • Defined in src/utility-types.ts:79
    • @@ -67,7 +67,7 @@
    Optional reason: string

    Returns void

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

    • Readonly resolve

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

    Returns void

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

    • Readonly worker

    worker: Worker

    The worker handling the execution.

    +
  • Defined in src/utility-types.ts:94
    • diff --git a/docs/interfaces/RequiredStatistics.html b/docs/interfaces/RequiredStatistics.html index 30d1a91f..6d38e844 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:49
    • @@ -43,21 +43,21 @@

    Require tasks average run time.

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

    • medRunTime

    medRunTime: boolean

    Require tasks median run time.

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

    • runTime

    runTime: boolean

    Require tasks run time.

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

    Task input data that will be passed to the worker.

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

    • Optional Readonly id

    id?: string

    UUID of the message.

    +
  • Defined in src/pools/worker.ts:46
    • diff --git a/docs/interfaces/TasksQueueOptions.html b/docs/interfaces/TasksQueueOptions.html index cfa8499d..f76fac16 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 8a562f5e..9ceedd7d 100644 --- a/docs/interfaces/TasksUsage.html +++ b/docs/interfaces/TasksUsage.html @@ -23,7 +23,7 @@
    • TasksUsage
    +
  • Defined in src/pools/worker.ts:54
    • @@ -47,49 +47,49 @@

    Average tasks runtime.

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

    • error

    error: number

    Number of tasks errored.

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

    • medRunTime

    medRunTime: number

    Median tasks runtime.

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

    • run

    run: number

    Number of tasks executed.

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

    • runTime

    runTime: number

    Tasks runtime.

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

    • runTimeHistory

    runTimeHistory: CircularArray<number>

    Tasks runtime history.

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

    • running

    running: number

    Number of tasks running.

    +
  • Defined in src/pools/worker.ts:62
    • diff --git a/docs/interfaces/WorkerChoiceStrategyOptions.html b/docs/interfaces/WorkerChoiceStrategyOptions.html index bea80c66..789b7f94 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
    • @@ -43,7 +43,7 @@

    Default Value

    false

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:41
    • diff --git a/docs/interfaces/WorkerNode.html b/docs/interfaces/WorkerNode.html index 199a6b29..cf54dab2 100644 --- a/docs/interfaces/WorkerNode.html +++ b/docs/interfaces/WorkerNode.html @@ -34,7 +34,7 @@
    • WorkerNode
    +
  • Defined in src/pools/worker.ts:115
    • @@ -54,21 +54,21 @@

    Worker node tasks queue.

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

    • tasksUsage

    tasksUsage: TasksUsage

    Worker node tasks usage statistics.

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

    • Readonly worker

    worker: Worker

    Worker node worker.

    +
  • Defined in src/pools/worker.ts:119
    • diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 1439b2c4..6d81ca02 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -23,7 +23,7 @@
    • WorkerOptions
    +
  • Defined in src/worker/worker-options.ts:38
    • @@ -45,7 +45,7 @@

    Default Value

    false

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

    • Optional killBehavior

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

    Default Value

    KillBehaviors.SOFT

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

    • Optional maxInactiveTime

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

    Default Value

    60000 ms

    +
  • Defined in src/worker/worker-options.ts:51
    • diff --git a/docs/types/Draft.html b/docs/types/Draft.html index 0112ecd7..54cc8f9f 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 0df36c04..bdd4606d 100644 --- a/docs/types/ErrorHandler.html +++ b/docs/types/ErrorHandler.html @@ -39,7 +39,7 @@
    e: Error

    Returns void

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

    Returns void

    +
  • Defined in src/pools/worker.ts:27
    • diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html index 953773cc..8a66bbd3 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 9a3a24d9..3bec5d35 100644 --- a/docs/types/MessageHandler.html +++ b/docs/types/MessageHandler.html @@ -39,7 +39,7 @@
    m: unknown

    Returns void

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

    Returns void

    +
  • Defined in src/pools/worker.ts:22
    • diff --git a/docs/types/PoolEvent.html b/docs/types/PoolEvent.html index cd77ee18..56564e85 100644 --- a/docs/types/PoolEvent.html +++ b/docs/types/PoolEvent.html @@ -19,7 +19,7 @@

    Pool event.

    +
  • Defined in src/pools/pool.ts:48
    • diff --git a/docs/types/ThreadWorkerWithMessageChannel.html b/docs/types/ThreadWorkerWithMessageChannel.html index 9d12fed4..cffbc5a3 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 7f8519fb..3c9c3236 100644 --- a/docs/types/WorkerAsyncFunction.html +++ b/docs/types/WorkerAsyncFunction.html @@ -20,9 +20,13 @@

    Type Parameters

    • -

      Data = unknown

      • +

      Data = unknown

      +

      Type of data sent to the worker. This can only be serializable data.

      +
    • -

      Response = unknown

    +

    Response = unknown

    +

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

    +

    Type declaration

      @@ -30,6 +34,9 @@
      • (data?: Data): Promise<Response>
      • +

        Worker asynchronous function that can be executed. +This function must return a promise.

        +

        Parameters

          @@ -37,7 +44,7 @@
          Optional data: Data

        Returns Promise<Response>

    +
  • Defined in src/utility-types.ts:58
    • diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index 32098b65..4300762e 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 38cbd979..65563b58 100644 --- a/docs/types/WorkerFunction.html +++ b/docs/types/WorkerFunction.html @@ -16,15 +16,22 @@
  • WorkerFunction

    • Type alias WorkerFunction<Data, Response>

    WorkerFunction<Data, Response>: WorkerSyncFunction<Data, Response> | WorkerAsyncFunction<Data, Response>
    +

    Worker function that can be executed. +This function can be synchronous or asynchronous.

    +

    Type Parameters

    • -

      Data = unknown

      • +

      Data = unknown

      +

      Type of data sent to the worker. This can only be serializable data.

      +
    • -

      Response = unknown

    +
  • Defined in src/utility-types.ts:68
    • diff --git a/docs/types/WorkerSyncFunction.html b/docs/types/WorkerSyncFunction.html index f689c2be..0bd14cf4 100644 --- a/docs/types/WorkerSyncFunction.html +++ b/docs/types/WorkerSyncFunction.html @@ -20,9 +20,13 @@

    Type Parameters

    • -

      Data = unknown

      • +

      Data = unknown

      +

      Type of data sent to the worker. This can only be serializable data.

      +
    • -

      Response = unknown

    +

    Response = unknown

    +

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

    +

    Type declaration

      @@ -30,7 +34,7 @@
      • (data?: Data): Response
      • -

        Worker function that can be executed types.

        +

        Worker synchronous function that can be executed.

        Parameters

        @@ -39,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 fbd7a300..12382073 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 a5d489d1..a63cbc8d 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 ad8523e4..d25ca5aa 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