From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 23 Apr 2023 10:21:01 +0000 (+0000) Subject: chore: generate documentation X-Git-Tag: v2.4.11~1 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=65ec4e64a4690b019d3ef86c97aa7182b715f539;p=poolifier.git chore: generate documentation --- diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 9d036250..5b3d2996 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -45,7 +45,7 @@ +
  • Defined in src/pools/abstract-pool.ts:33
    • @@ -150,7 +150,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

    @@ -165,28 +165,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>> = ...
    @@ -198,7 +198,7 @@

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

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

    • Protected workerChoiceStrategyContext

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

    Default to a round robin algorithm.

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

    • Readonly workerNodes

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

    • Accessors

    @@ -227,7 +227,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

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

    Returns void

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

    • Protected Abstract afterWorkerSetup

    Returns void

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

    • Protected beforeTaskExecutionHook

    Returns void

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

    Returns void | Promise<void>

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueueByWorker

    Returns void

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

    • Private flushTasksQueues

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

    • Private getWorkerNodeKey

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

    • Private getWorkerTasksUsage

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

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

    • Protected Abstract registerWorkerMessageListener

    Returns void

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

    • Private removeWorkerNode

    Returns void

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

    • Protected Abstract sendToWorker

    Returns void

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

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

    • Private setWorkerNodeTasksUsage

    Returns void

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

    • Protected setupHook

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

    • Private tasksQueueSize

    Returns number

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:504
    • diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 18a43c17..ee6528c7 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

    @@ -173,7 +173,7 @@
    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:315

    • bind

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

      Returns Func & {
          asyncResource: AsyncResource;
      }

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:288

    • Protected checkAlive

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

    Returns void

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

    • Private checkFunctionInput

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

    Returns void

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

    • Private checkWorkerOptions

    Returns void

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

    • emitDestroy

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:311

    • Protected getMainWorker

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

    • Protected handleError

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

    • Protected messageListener

    Returns void

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

    • 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

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:303

    • Protected Abstract sendToMainWorker

    Returns void

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

    • triggerAsyncId

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:320

    • Static bind

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:273
    • diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index b149f868..3604f40d 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -30,7 +30,7 @@
    • CircularArray
    +
  • 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

    Returns void

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

    • concat

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

    • copyWithin

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

    • entries

      @@ -686,7 +686,7 @@ thisArg is omitted, undefined is used as the this value.

    • Returns boolean

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

    • includes

      @@ -851,7 +851,7 @@ If the array is empty, undefined is returned and the array is not modified.

      Returns number

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

    • reduce

      @@ -1076,7 +1076,7 @@ If the array is empty, undefined is returned and the array is not modified.

      size: number

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

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

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:315

    • bind

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:288

    • Protected checkAlive

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

    • emitDestroy

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:311

    • Protected getMainWorker

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:303

    • Protected sendToMainWorker

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

    • triggerAsyncId

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:320

    • Static bind

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:273
    • diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 65a33345..03fbe182 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -42,7 +42,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    • DynamicClusterPool
    +
  • Defined in src/pools/cluster/dynamic.ts:16
    • @@ -131,7 +131,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

    @@ -146,7 +146,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
    @@ -154,14 +154,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
    @@ -169,7 +169,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 = {}
    @@ -177,7 +177,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>> = ...
    @@ -190,7 +190,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>
    @@ -199,7 +199,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>[] = []
    @@ -207,7 +207,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

    @@ -221,7 +221,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

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

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

    • 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:504
    • diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 3bb7453c..734d1642 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
    • @@ -131,7 +131,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

    @@ -146,7 +146,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
    @@ -154,14 +154,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
    @@ -169,7 +169,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>
    @@ -177,7 +177,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>> = ...
    @@ -190,7 +190,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>
    @@ -199,7 +199,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>[] = []
    @@ -207,7 +207,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

    @@ -221,7 +221,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

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

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

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:504
    • diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index acc8d0af..412adcef 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:39
    • @@ -128,7 +128,7 @@

    Returns FixedClusterPool<Data, Response>

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

    • Properties

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

    • Readonly filePath

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

    • Readonly numberOfWorkers

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

    • Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -211,7 +211,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

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

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

    • 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:504
    • diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index fb2be6c3..afdb1f84 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -44,7 +44,7 @@ +
  • Defined in src/pools/thread/fixed.ts:29
    • @@ -128,7 +128,7 @@

    Returns FixedThreadPool<Data, Response>

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

    • Properties

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

    • Readonly filePath

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

    • Readonly numberOfWorkers

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

    • Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -211,7 +211,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

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

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

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:504
    • diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index 8eca224f..886dad9d 100644 --- a/docs/classes/PoolEmitter.html +++ b/docs/classes/PoolEmitter.html @@ -25,7 +25,7 @@
    • PoolEmitter
    +
  • Defined in src/pools/pool.ts:35
    • @@ -80,7 +80,7 @@

    Returns PoolEmitter

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:111

    • Properties

    @@ -88,7 +88,7 @@
    captureRejectionSymbol: typeof captureRejectionSymbol
    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:328

    • Static captureRejections

    captureRejections: boolean
    @@ -96,13 +96,13 @@
    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:333

    • Static defaultMaxListeners

    defaultMaxListeners: number
    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:334

    • Static Readonly errorMonitor

    errorMonitor: typeof errorMonitor
    @@ -115,7 +115,7 @@ regular 'error' listener is installed.

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:327

    • Methods

    @@ -148,7 +148,7 @@ regular 'error' listener is installed.

    Returns PoolEmitter

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:354

    • emit

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:610

    • eventNames

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:673

    • getMaxListeners

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:526

    • listenerCount

    Returns number

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:620

    • listeners

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:539

    • off

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:499

    • on

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:385

    • once

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:414

    • prependListener

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:638

    • prependOnceListener

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:654

    • rawListeners

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:569

    • removeAllListeners

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:510

    • removeListener

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:494

    • setMaxListeners

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:520

    • Static getEventListeners

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:299

    • Static listenerCount

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:271

    • Static on

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:254

    • Static once

  • @@ -698,7 +704,7 @@ special handling:

    Returns Promise<any[]>

    • +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:195

    • Static setMaxListeners

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/events.d.ts:317
    • diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index d6b1fd3b..03f2c120 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

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

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:315

    • bind

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:288

    • Protected checkAlive

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

    • emitDestroy

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:311

    • Protected getMainWorker

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:303

    • Protected sendToMainWorker

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

    • triggerAsyncId

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:320

    • Static bind

    +
  • Defined in node_modules/.pnpm/@types+node@18.16.0/node_modules/@types/node/async_hooks.d.ts:273
    • diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 4651ea23..7f67cf5a 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -38,7 +38,7 @@
    • WorkerChoiceStrategyContext
    +
  • 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

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

    Returns number

    The key of the worker node.

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

    • getRequiredStatistics

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

    • remove

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

    • setOptions

    Returns void

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

    • setWorkerChoiceStrategy

    Returns void

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:108
    • diff --git a/docs/enums/PoolType.html b/docs/enums/PoolType.html index cafd4184..21439ec1 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 986f7e54..9d1adb8e 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 2e4ac39b..d010c608 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -42,7 +42,7 @@ +
  • Defined in src/pools/pool.ts:119
    • @@ -76,7 +76,7 @@

    Returns Promise<void>

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

    • Optional Readonly emitter

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

    • enableTasksQueue

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

    Returns void

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

    • execute

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

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    • setTasksQueueOptions

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

    Returns void

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

    • setWorkerChoiceStrategy

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

    Returns void

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

    • setWorkerChoiceStrategyOptions

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

    Returns void

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

    • Readonly type

    type: PoolType
    @@ -215,14 +215,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 2f18f026..895b5e60 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, handler) => 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 35995dd4..3370fa58 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) => 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) => 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 87aa7d2b..3cf315bd 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 596ccbf7..5eee8fe1 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 77ad3a5d..c5f73805 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) => 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 888c0ecf..2aa42b53 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 5aff22f0..8c9b7d16 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 37cfa603..146bab93 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 ff6a1841..81902f82 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 8e81bc7b..33a9e312 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 2dba9845..cb7c7763 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 c8ae8385..ce2bb5d7 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

    +
  • Defined in src/worker/worker-options.ts:51
    • diff --git a/docs/types/Draft.html b/docs/types/Draft.html index 4bf36fbd..6022036a 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 d970e9d1..698af0bd 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 7411899c..9b68fabe 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 ec923083..8d5398f3 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 cb50e284..0da694c3 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 55ab75ed..5c16e2b5 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 0acff14d..843e4e58 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 7174e0a5..d46c9b1d 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 0c463b76..bcaf3a6f 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:58
    • diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index e48ee5a0..7c6928ab 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 b61aec7b..eebb019a 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:68
    • diff --git a/docs/types/WorkerSyncFunction.html b/docs/types/WorkerSyncFunction.html index b2a635a4..c95a52a9 100644 --- a/docs/types/WorkerSyncFunction.html +++ b/docs/types/WorkerSyncFunction.html @@ -43,7 +43,7 @@
    Optional data: Data

    Returns Response

    +
  • Defined in src/utility-types.ts:48
    • diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html index 93d3e913..6f603e77 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 968be7a9..e9344c95 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 50f47131..078af9b0 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