From 6d6c7ed0c2c3c83cefae4d8cd5bc9393126bba70 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 1 Jul 2023 17:32:36 +0000 Subject: [PATCH] chore: generate documentation --- docs/classes/AbstractPool.html | 124 +++++++++--------- docs/classes/AbstractWorker.html | 58 ++++---- docs/classes/CircularArray.html | 22 ++-- docs/classes/ClusterWorker.html | 46 +++---- docs/classes/DynamicClusterPool.html | 70 +++++----- docs/classes/DynamicThreadPool.html | 70 +++++----- docs/classes/FixedClusterPool.html | 68 +++++----- docs/classes/FixedThreadPool.html | 68 +++++----- docs/classes/PoolEmitter.html | 54 ++++---- docs/classes/Queue.html | 20 +-- docs/classes/ThreadWorker.html | 46 +++---- docs/classes/WorkerChoiceStrategyContext.html | 22 ++-- docs/functions/availableParallelism.html | 8 +- docs/interfaces/ClusterPoolOptions.html | 26 ++-- ...tLoopUtilizationMeasurementStatistics.html | 8 +- docs/interfaces/IPool.html | 20 +-- docs/interfaces/IWorker.html | 6 +- docs/interfaces/IWorkerChoiceStrategy.html | 16 +-- docs/interfaces/MeasurementOptions.html | 4 +- docs/interfaces/MeasurementStatistics.html | 10 +- .../MeasurementStatisticsRequirements.html | 8 +- docs/interfaces/MessageValue.html | 18 +-- docs/interfaces/PoolInfo.html | 26 ++-- docs/interfaces/PoolOptions.html | 22 ++-- docs/interfaces/PromiseResponseWrapper.html | 8 +- docs/interfaces/StrategyPolicy.html | 4 +- docs/interfaces/Task.html | 10 +- docs/interfaces/TaskError.html | 6 +- docs/interfaces/TaskPerformance.html | 8 +- docs/interfaces/TaskStatistics.html | 12 +- .../TaskStatisticsRequirements.html | 8 +- docs/interfaces/TasksQueueOptions.html | 4 +- docs/interfaces/ThreadPoolOptions.html | 24 ++-- .../WorkerChoiceStrategyOptions.html | 12 +- docs/interfaces/WorkerNode.html | 8 +- docs/interfaces/WorkerOptions.html | 8 +- docs/interfaces/WorkerStatistics.html | 6 +- docs/interfaces/WorkerUsage.html | 10 +- docs/types/ErrorHandler.html | 2 +- docs/types/ExitHandler.html | 2 +- docs/types/KillBehavior.html | 2 +- docs/types/Measurement.html | 2 +- docs/types/MessageHandler.html | 2 +- docs/types/OnlineHandler.html | 2 +- docs/types/PoolEvent.html | 2 +- docs/types/PoolType.html | 2 +- docs/types/TaskFunctions.html | 2 +- docs/types/WorkerAsyncFunction.html | 2 +- docs/types/WorkerChoiceStrategy.html | 2 +- docs/types/WorkerFunction.html | 2 +- docs/types/WorkerSyncFunction.html | 2 +- docs/types/WorkerType.html | 2 +- docs/variables/KillBehaviors.html | 2 +- docs/variables/Measurements.html | 2 +- docs/variables/PoolEvents.html | 2 +- docs/variables/PoolTypes.html | 2 +- docs/variables/WorkerChoiceStrategies.html | 2 +- docs/variables/WorkerTypes.html | 2 +- 58 files changed, 505 insertions(+), 503 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 9283ff10..c6bf43ba 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -49,7 +49,7 @@ +
  • Defined in src/pools/abstract-pool.ts:46
    • @@ -167,7 +167,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

    opts: PoolOptions<Worker>
    @@ -209,7 +209,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:89

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -253,7 +253,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected Abstract maxSize

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

    • Protected Abstract minSize

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

    • Protected Abstract type

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

    • Protected Abstract worker

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    • Private checkFilePath

    Returns void

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    • Private getWorkerNodeKey

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

    • Private getWorkerUsage

    Returns WorkerUsage

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

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

    • Private registerWorkerMessageListener

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

    • Private removeWorkerNode

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

    • Protected Abstract sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Private setWorkerNodeTasksUsage

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

    • Private setWorkerStatistics

    Returns void

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

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

    • Private tasksMaxQueueSize

    Returns number

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

    • Private tasksQueueSize

    Returns number

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

    • Private updateEluWorkerUsage

    Returns void

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

    • Private updateRunTimeWorkerUsage

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

    Returns void

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

    • Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:764
    • diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index fe134d40..a66831e4 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -47,7 +47,7 @@
  • ClusterWorker
  • ThreadWorker
    • +
  • Defined in src/worker/abstract-worker.ts:34
    • @@ -139,7 +139,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:64

    • Properties

    @@ -149,7 +149,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:54

    • Protected Readonly isMain

    isMain: boolean
    @@ -157,7 +157,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:66

    • Protected lastTaskTimestamp

    lastTaskTimestamp: number
    @@ -165,7 +165,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:46

    • Protected Readonly mainWorker

    mainWorker: MainWorker
    @@ -173,7 +173,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:70

    • Protected Readonly opts

    opts: WorkerOptions = ...
    @@ -181,7 +181,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:71

    • Protected statistics

    statistics: WorkerStatistics
    @@ -189,7 +189,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:50

    • Protected taskFunctions

    taskFunctions: Map<string, WorkerFunction<Data, Response>>
    @@ -197,7 +197,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:42

    • Methods

    @@ -210,7 +210,7 @@
    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:306

    • Private beginTaskPerformance

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

    • bind

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:283

    • Protected checkAlive

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

    • Private checkStatistics

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

    • Private checkTaskFunctions

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

    • Private checkWorkerOptions

    Returns void

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

    • emitDestroy

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:302

    • Private endTaskPerformance

    Returns TaskPerformance

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

    • Protected getMainWorker

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

    • Private getTaskFunction

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

    • Protected handleError

    -

    Returns string

    Message of the error.

    +

    Returns string

    The error message.

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

    • Protected messageListener

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

    • Protected runAsync

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

    • runInAsyncScope

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:294

    • Protected runSync

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

    • Protected Abstract sendToMainWorker

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

    • triggerAsyncId

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

    • Static bind

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:277
    • diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 34f5bfa2..ea460d29 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -31,7 +31,7 @@
    • CircularArray
    +
  • Defined in src/circular-array.ts:8
    • @@ -113,7 +113,7 @@

    Returns CircularArray<T>

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

    • Properties

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

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

      Inherit Doc

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

    • copyWithin

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

    • entries

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

    • includes

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

    • reduce

    Returns void

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

    • reverse

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

    • toLocaleString

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

    • values

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

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

    • Properties

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

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

    • Protected Readonly isMain

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

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

    • Protected lastTaskTimestamp

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

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

    • Protected Readonly mainWorker

    mainWorker: Worker
    @@ -154,7 +154,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected Readonly opts

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

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

    • Protected statistics

    statistics: WorkerStatistics
    @@ -172,7 +172,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected taskFunctions

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

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

    • Methods

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

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:306

    • bind

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:283

    • Protected checkAlive

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

    • emitDestroy

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:302

    • Protected getMainWorker

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

    • Protected handleError

    -

    Returns string

    Message of the error.

    +

    Returns string

    The error message.

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

    • Protected messageListener

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

    • Protected runAsync

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

    • runInAsyncScope

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:294

    • Protected runSync

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

    • Protected sendToMainWorker

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

    • triggerAsyncId

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

    • Static bind

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:277
    • diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index b0b2c4d3..bba68781 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    • DynamicClusterPool
    +
  • Defined in src/pools/cluster/dynamic.ts:15
    • @@ -140,7 +140,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:27

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly max

    max: number
    @@ -175,7 +175,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:29

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

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

    • Protected full

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

    • info

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

    • Protected maxSize

      @@ -277,7 +277,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:42

    • Protected minSize

      @@ -289,7 +289,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/fixed.ts:97

    • Protected type

      @@ -302,7 +302,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:37

    • Protected worker

      @@ -314,7 +314,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/fixed.ts:92

    • Methods

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

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:764
    • diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 2009248d..b9f6083d 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -45,7 +45,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    • DynamicThreadPool
    +
  • Defined in src/pools/thread/dynamic.ts:15
    • @@ -140,7 +140,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:27

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly max

    max: number
    @@ -175,7 +175,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:29

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

    opts: ThreadPoolOptions = {}
    @@ -193,7 +193,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/fixed.ts:51

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

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

    • Protected full

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

    • info

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

    • Protected maxSize

      @@ -277,7 +277,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:42

    • Protected minSize

      @@ -289,7 +289,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/fixed.ts:91

    • Protected type

      @@ -302,7 +302,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:37

    • Protected worker

      @@ -314,7 +314,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/fixed.ts:86

    • Methods

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

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:764
    • diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 150e72e8..da5465cd 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:38
    • @@ -134,7 +134,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:49

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -226,7 +226,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:107

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Protected type

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:764
    • diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index b23ee1e7..a9e9ac7e 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -45,7 +45,7 @@ +
  • Defined in src/pools/thread/fixed.ts:37
    • @@ -134,7 +134,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:48

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

    opts: ThreadPoolOptions = {}
    @@ -179,7 +179,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:51

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -226,7 +226,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:101

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Protected type

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:764
    • diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index 69b45220..59b4cdd4 100644 --- a/docs/classes/PoolEmitter.html +++ b/docs/classes/PoolEmitter.html @@ -26,7 +26,7 @@
    • PoolEmitter
    +
  • Defined in src/pools/pool.ts:50
    • @@ -81,7 +81,7 @@

    Returns PoolEmitter

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:109

    • Properties

    @@ -95,7 +95,7 @@
    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:326

    • Static captureRejections

    captureRejections: boolean
    @@ -107,7 +107,7 @@
    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:333

    • Static defaultMaxListeners

    defaultMaxListeners: number
    @@ -138,7 +138,7 @@ Its name property is set to 'MaxListenersExceededWarning&
    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:370

    • Static Readonly errorMonitor

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

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:319

    • Methods

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

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:390

    • emit

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:652

    • eventNames

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:715

    • getMaxListeners

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:567

    • listenerCount

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:661

    • listeners

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:580

    • off

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:540

    • on

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:422

    • once

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:452

    • prependListener

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:679

    • prependOnceListener

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:695

    • rawListeners

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:611

    • removeAllListeners

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:551

    • removeListener

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:535

    • setMaxListeners

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:561

    • Static getEventListeners

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:296

    • Static listenerCount

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:268

    • Static on

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:250

    • Static once

  • @@ -772,7 +772,7 @@ special handling:

    Returns Promise<any[]>

    • +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:190

    • Static setMaxListeners

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/events.d.ts:311
    • diff --git a/docs/classes/Queue.html b/docs/classes/Queue.html index ecd5e0e3..c986cd4a 100644 --- a/docs/classes/Queue.html +++ b/docs/classes/Queue.html @@ -32,7 +32,7 @@
    • Queue
    +
  • Defined in src/queue.ts:8
    • @@ -70,14 +70,14 @@

    T

    Returns Queue<T>

    +
  • Defined in src/queue.ts:16

    • Properties

    Private items

    items: T[]
    +
  • Defined in src/queue.ts:9

    • maxSize

    maxSize: number
    @@ -85,12 +85,12 @@
    +
  • Defined in src/queue.ts:14

    • Private offset

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

    • size

    size: number
    @@ -98,7 +98,7 @@
    +
  • Defined in src/queue.ts:12

    • Methods

    @@ -111,7 +111,7 @@

    Returns void

    +
  • Defined in src/queue.ts:68

    • dequeue

    +
  • Defined in src/queue.ts:40

    • enqueue

    +
  • Defined in src/queue.ts:26

    • peek

    +
  • Defined in src/queue.ts:58
    • diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 9546adda..f83474f1 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.

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

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

    • Properties

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

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

    • Protected Readonly isMain

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

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

    • Protected lastTaskTimestamp

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

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

    • Protected Readonly mainWorker

    mainWorker: MessagePort
    @@ -154,7 +154,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected Readonly opts

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

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

    • Protected statistics

    statistics: WorkerStatistics
    @@ -172,7 +172,7 @@ but the minimum number of workers will be guaranteed.

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

    • Protected taskFunctions

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

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

    • Methods

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

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:306

    • bind

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

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:283

    • Protected checkAlive

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

    • emitDestroy

      @@ -249,7 +249,7 @@ never be called.

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:302

    • Protected getMainWorker

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

    • Protected handleError

      @@ -278,12 +278,12 @@ never be called.

      The error raised by the worker.

    -

    Returns string

    Message of the error.

    +

    Returns string

    The error message.

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

    • Protected messageListener

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

    • Protected runAsync

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

    • runInAsyncScope

      @@ -383,7 +383,7 @@ then restore the original execution context.

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:294

    • Protected runSync

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

    • Protected sendToMainWorker

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

    • triggerAsyncId

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

    • Static bind

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:277
    • diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index d477079a..d3361e80 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -42,7 +42,7 @@
    • WorkerChoiceStrategyContext
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:27
    • @@ -106,14 +106,14 @@

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

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

    • Properties

    Private Readonly workerChoiceStrategies

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

    • Private workerChoiceStrategy

    workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN
    @@ -121,7 +121,7 @@
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:46

    • Methods

    @@ -137,7 +137,7 @@

    Throws

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

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

    • getStrategyPolicy

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

    • getTaskStatisticsRequirements

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

    • remove

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

    • setOptions

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

    • setWorkerChoiceStrategy

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

    • update

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:153
    • diff --git a/docs/functions/availableParallelism.html b/docs/functions/availableParallelism.html index 43bf0a60..78c90fae 100644 --- a/docs/functions/availableParallelism.html +++ b/docs/functions/availableParallelism.html @@ -19,12 +19,14 @@
    • -

      Safe helper to get the host OS optimized maximum pool size.

      +

      Returns safe host OS optimized estimate of the default amount of parallelism a pool should use. +Always returns a value greater than zero.

      -

      Returns number

      +

      Returns number

      The host OS optimized maximum pool size.

      +
    +
  • Defined in src/utils.ts:40
    • diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index a102926c..8412d316 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -26,7 +26,7 @@
    • ClusterPoolOptions
    +
  • Defined in src/pools/cluster/fixed.ts:15
    • @@ -59,7 +59,7 @@
    +
  • Defined in src/pools/pool.ts:138

    • Optional enableTasksQueue

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

    • Optional env

    env?: Record<string, unknown>
    @@ -80,7 +80,7 @@

    See

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

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

    • Optional errorHandler

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

    • Optional exitHandler

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

    • Optional messageHandler

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

    • Optional onlineHandler

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

    • Optional restartWorkerOnError

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

    • Optional settings

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

    See

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

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

    • Optional tasksQueueOptions

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

    • Optional workerChoiceStrategy

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

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/pool.ts:128
    • diff --git a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html index 2dfb8ade..5e763ecf 100644 --- a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html +++ b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html @@ -24,7 +24,7 @@
    • EventLoopUtilizationMeasurementStatistics
    +
  • Defined in src/pools/worker.ts:87
    • @@ -42,17 +42,17 @@

    active

    active: MeasurementStatistics
    +
  • Defined in src/pools/worker.ts:89

    • idle

    idle: MeasurementStatistics
    +
  • Defined in src/pools/worker.ts:88

    • utilization

    utilization: number
    +
  • Defined in src/pools/worker.ts:90
    • diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 602223db..978eaa3f 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:158
    • @@ -81,7 +81,7 @@

    Returns Promise<void>

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

    • Optional Readonly emitter

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

    • enableTasksQueue

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

    Returns void

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

    • execute

    execute: ((data?, name?) => Promise<Response>)
    @@ -155,7 +155,7 @@
    +
  • Defined in src/pools/pool.ts:189

    • Readonly info

    info: PoolInfo
    @@ -163,7 +163,7 @@
    +
  • Defined in src/pools/pool.ts:166

    • setTasksQueueOptions

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

    Returns void

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

    • setWorkerChoiceStrategy

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

    Returns void

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

    • setWorkerChoiceStrategyOptions

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

    Returns void

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

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[]
    @@ -248,7 +248,7 @@
    +
  • Defined in src/pools/pool.ts:170
    • diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index 372adfec..af44f0dd 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -24,7 +24,7 @@
    • IWorker
    +
  • Defined in src/pools/worker.ts:148
    • @@ -108,7 +108,7 @@

    Param

    The event handler.

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

    • once

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

    Returns void

    +
  • Defined in src/pools/worker.ts:165
    • diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 694a3c4c..a93f631b 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -24,7 +24,7 @@
    • IWorkerChoiceStrategy
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:158
    • @@ -58,7 +58,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:184

    • remove

    remove: ((workerNodeKey) => boolean)
    @@ -83,7 +83,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:191

    • reset

    reset: (() => boolean)
    @@ -100,7 +100,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:172

    • setOptions

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

    Returns void

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

    • Readonly strategyPolicy

    strategyPolicy: StrategyPolicy
    @@ -132,7 +132,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:162

    • Readonly taskStatisticsRequirements

    taskStatisticsRequirements: TaskStatisticsRequirements
    @@ -140,7 +140,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:166

    • update

    update: ((workerNodeKey) => boolean)
    @@ -162,7 +162,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:178
    • diff --git a/docs/interfaces/MeasurementOptions.html b/docs/interfaces/MeasurementOptions.html index 0d92210d..3d33ffc8 100644 --- a/docs/interfaces/MeasurementOptions.html +++ b/docs/interfaces/MeasurementOptions.html @@ -24,7 +24,7 @@
    • MeasurementOptions
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:61
    • @@ -43,7 +43,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:65
    • diff --git a/docs/interfaces/MeasurementStatistics.html b/docs/interfaces/MeasurementStatistics.html index 4888ebf6..340ff454 100644 --- a/docs/interfaces/MeasurementStatistics.html +++ b/docs/interfaces/MeasurementStatistics.html @@ -24,7 +24,7 @@
    • MeasurementStatistics
    +
  • Defined in src/pools/worker.ts:63
    • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:67

    • average

    average: number
    @@ -54,7 +54,7 @@
    +
  • Defined in src/pools/worker.ts:71

    • history

    history: CircularArray<number>
    @@ -62,7 +62,7 @@
    +
  • Defined in src/pools/worker.ts:79

    • median

    median: number
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:75
    • diff --git a/docs/interfaces/MeasurementStatisticsRequirements.html b/docs/interfaces/MeasurementStatisticsRequirements.html index 9c3dcb8e..ec802e26 100644 --- a/docs/interfaces/MeasurementStatisticsRequirements.html +++ b/docs/interfaces/MeasurementStatisticsRequirements.html @@ -24,7 +24,7 @@
    • MeasurementStatisticsRequirements
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:108
    • @@ -45,7 +45,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:112

    • average

    average: boolean
    @@ -53,7 +53,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:116

    • median

    median: boolean
    @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:120
    • diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index ea1fef19..6dce4e38 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -39,7 +39,7 @@
    • MessageValue
    +
  • Defined in src/utility-types.ts:54
    • @@ -66,7 +66,7 @@
    +
  • Defined in src/pools/worker.ts:47

    • Optional Readonly id

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

    • Optional Readonly kill

    kill?: 1 | "SOFT" | "HARD"
    @@ -83,7 +83,7 @@
    +
  • Defined in src/utility-types.ts:59

    • Optional Readonly name

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

    • Optional Readonly statistics

    statistics?: WorkerStatistics
    @@ -100,7 +100,7 @@
    +
  • Defined in src/utility-types.ts:71

    • Optional Readonly taskError

    taskError?: TaskError<ErrorData>
    @@ -108,7 +108,7 @@
    +
  • Defined in src/utility-types.ts:63

    • Optional Readonly taskPerformance

    taskPerformance?: TaskPerformance
    @@ -116,7 +116,7 @@
    +
  • Defined in src/utility-types.ts:67

    • Optional Readonly timestamp

    timestamp?: number
    @@ -125,7 +125,7 @@
    +
  • Defined in src/pools/worker.ts:51
    • diff --git a/docs/interfaces/PoolInfo.html b/docs/interfaces/PoolInfo.html index 61a646f2..98df631d 100644 --- a/docs/interfaces/PoolInfo.html +++ b/docs/interfaces/PoolInfo.html @@ -24,7 +24,7 @@
    • PoolInfo
    +
  • Defined in src/pools/pool.ts:70
    • @@ -51,62 +51,62 @@

    busyWorkerNodes

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

    • executedTasks

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

    • executingTasks

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

    • failedTasks

    failedTasks: number
    +
  • Defined in src/pools/pool.ts:82

    • idleWorkerNodes

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

    • maxQueuedTasks

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

    • maxSize

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

    • minSize

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

    • queuedTasks

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

    • type

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

    • worker

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

    • workerNodes

    workerNodes: number
    +
  • Defined in src/pools/pool.ts:75
    • diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 2c9854f4..9289b873 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -35,7 +35,7 @@
  • ClusterPoolOptions
  • ThreadPoolOptions
    • +
  • Defined in src/pools/pool.ts:102
    • @@ -65,7 +65,7 @@

    Default Value

    true

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

    • Optional enableTasksQueue

    enableTasksQueue?: boolean
    @@ -75,7 +75,7 @@

    Default Value

    false

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

    • Optional errorHandler

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

    • Optional exitHandler

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

    • Optional messageHandler

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

    • Optional onlineHandler

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

    • Optional restartWorkerOnError

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

    • Optional tasksQueueOptions

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

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    @@ -133,7 +133,7 @@

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN

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

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -141,7 +141,7 @@
    +
  • Defined in src/pools/pool.ts:128
    • diff --git a/docs/interfaces/PromiseResponseWrapper.html b/docs/interfaces/PromiseResponseWrapper.html index 45470a3d..d69f7106 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -37,7 +37,7 @@
    • PromiseResponseWrapper
    +
  • Defined in src/utility-types.ts:81
    • @@ -71,7 +71,7 @@

    Returns void

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

    • Readonly resolve

    resolve: ((value) => void)
    @@ -92,7 +92,7 @@

    Returns void

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

    • Readonly worker

    worker: Worker
    @@ -100,7 +100,7 @@
    +
  • Defined in src/utility-types.ts:96
    • diff --git a/docs/interfaces/StrategyPolicy.html b/docs/interfaces/StrategyPolicy.html index 0819c17d..f026c3ed 100644 --- a/docs/interfaces/StrategyPolicy.html +++ b/docs/interfaces/StrategyPolicy.html @@ -24,7 +24,7 @@
    • StrategyPolicy
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:148
    • @@ -43,7 +43,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:152
    • diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index eb99ce04..91fee4e2 100644 --- a/docs/interfaces/Task.html +++ b/docs/interfaces/Task.html @@ -34,7 +34,7 @@ +
  • Defined in src/pools/worker.ts:39
    • @@ -56,7 +56,7 @@
    +
  • Defined in src/pools/worker.ts:47

    • Optional Readonly id

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

    • Optional Readonly name

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

    • Optional Readonly timestamp

    timestamp?: number
    @@ -80,7 +80,7 @@
    +
  • Defined in src/pools/worker.ts:51
    • diff --git a/docs/interfaces/TaskError.html b/docs/interfaces/TaskError.html index 903af6d4..6f3d8ddf 100644 --- a/docs/interfaces/TaskError.html +++ b/docs/interfaces/TaskError.html @@ -32,7 +32,7 @@
    • TaskError
    +
  • Defined in src/utility-types.ts:10
    • @@ -52,7 +52,7 @@
    +
  • Defined in src/utility-types.ts:18

    • message

    message: string
    @@ -60,7 +60,7 @@
    +
  • Defined in src/utility-types.ts:14
    • diff --git a/docs/interfaces/TaskPerformance.html b/docs/interfaces/TaskPerformance.html index 0d9d0768..2cbd971f 100644 --- a/docs/interfaces/TaskPerformance.html +++ b/docs/interfaces/TaskPerformance.html @@ -24,7 +24,7 @@
    • TaskPerformance
    +
  • Defined in src/utility-types.ts:24
    • @@ -45,7 +45,7 @@
    +
  • Defined in src/utility-types.ts:36

    • Optional runTime

    runTime?: number
    @@ -53,7 +53,7 @@
    +
  • Defined in src/utility-types.ts:32

    • timestamp

    timestamp: number
    @@ -61,7 +61,7 @@
    +
  • Defined in src/utility-types.ts:28
    • diff --git a/docs/interfaces/TaskStatistics.html b/docs/interfaces/TaskStatistics.html index 534a8094..d666b4a3 100644 --- a/docs/interfaces/TaskStatistics.html +++ b/docs/interfaces/TaskStatistics.html @@ -24,7 +24,7 @@
    • TaskStatistics
    +
  • Defined in src/pools/worker.ts:98
    • @@ -47,7 +47,7 @@
    +
  • Defined in src/pools/worker.ts:102

    • executing

    executing: number
    @@ -55,7 +55,7 @@
    +
  • Defined in src/pools/worker.ts:106

    • failed

    failed: number
    @@ -63,7 +63,7 @@
    +
  • Defined in src/pools/worker.ts:118

    • Readonly maxQueued

    maxQueued: number
    @@ -71,7 +71,7 @@
    +
  • Defined in src/pools/worker.ts:114

    • Readonly queued

    queued: number
    @@ -79,7 +79,7 @@
    +
  • Defined in src/pools/worker.ts:110
    • diff --git a/docs/interfaces/TaskStatisticsRequirements.html b/docs/interfaces/TaskStatisticsRequirements.html index f1598f8e..196d1e24 100644 --- a/docs/interfaces/TaskStatisticsRequirements.html +++ b/docs/interfaces/TaskStatisticsRequirements.html @@ -24,7 +24,7 @@
    • TaskStatisticsRequirements
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:128
    • @@ -45,7 +45,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:140

    • runTime

    runTime: MeasurementStatisticsRequirements
    @@ -53,7 +53,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:132

    • waitTime

    waitTime: MeasurementStatisticsRequirements
    @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:136
    • diff --git a/docs/interfaces/TasksQueueOptions.html b/docs/interfaces/TasksQueueOptions.html index c5849799..dcc83aae 100644 --- a/docs/interfaces/TasksQueueOptions.html +++ b/docs/interfaces/TasksQueueOptions.html @@ -24,7 +24,7 @@
    • TasksQueueOptions
    +
  • Defined in src/pools/pool.ts:88
    • @@ -45,7 +45,7 @@

    Default Value

    1

    +
  • Defined in src/pools/pool.ts:94
    • diff --git a/docs/interfaces/ThreadPoolOptions.html b/docs/interfaces/ThreadPoolOptions.html index f670e885..af2dc7ae 100644 --- a/docs/interfaces/ThreadPoolOptions.html +++ b/docs/interfaces/ThreadPoolOptions.html @@ -26,7 +26,7 @@
    • ThreadPoolOptions
    +
  • Defined in src/pools/thread/fixed.ts:20
    • @@ -58,7 +58,7 @@
    +
  • Defined in src/pools/pool.ts:138

    • Optional enableTasksQueue

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

    • Optional errorHandler

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

    • Optional exitHandler

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

    • Optional messageHandler

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

    • Optional onlineHandler

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

    • Optional restartWorkerOnError

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

    • Optional tasksQueueOptions

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

    • Optional workerChoiceStrategy

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

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -143,7 +143,7 @@
    +
  • Defined in src/pools/pool.ts:128

    • Optional workerOptions

    workerOptions?: WorkerOptions
    @@ -153,7 +153,7 @@

    See

    https://nodejs.org/api/worker_threads.html#new-workerfilename-options

    +
  • Defined in src/pools/thread/fixed.ts:26
    • diff --git a/docs/interfaces/WorkerChoiceStrategyOptions.html b/docs/interfaces/WorkerChoiceStrategyOptions.html index 5b3bf9c8..cd702216 100644 --- a/docs/interfaces/WorkerChoiceStrategyOptions.html +++ b/docs/interfaces/WorkerChoiceStrategyOptions.html @@ -24,7 +24,7 @@
    • WorkerChoiceStrategyOptions
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:71
    • @@ -49,7 +49,7 @@

    Default Value

    { median: false }

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

    • Optional measurement

    measurement?: "runTime" | "waitTime" | "elu"
    @@ -57,7 +57,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:75

    • Optional runTime

    runTime?: MeasurementOptions
    @@ -67,7 +67,7 @@

    Default Value

    { median: false }

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

    • Optional waitTime

    waitTime?: MeasurementOptions
    @@ -77,7 +77,7 @@

    Default Value

    { median: false }

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

    • Optional weights

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

    Default Value

    Computed worker weights automatically given the CPU performance.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:100
    • diff --git a/docs/interfaces/WorkerNode.html b/docs/interfaces/WorkerNode.html index 1d602e9f..026253d7 100644 --- a/docs/interfaces/WorkerNode.html +++ b/docs/interfaces/WorkerNode.html @@ -37,7 +37,7 @@
    • WorkerNode
    +
  • Defined in src/pools/worker.ts:175
    • @@ -58,7 +58,7 @@
    +
  • Defined in src/pools/worker.ts:187

    • usage

    usage: WorkerUsage
    @@ -66,7 +66,7 @@
    +
  • Defined in src/pools/worker.ts:183

    • Readonly worker

    worker: Worker
    @@ -74,7 +74,7 @@
    +
  • Defined in src/pools/worker.ts:179
    • diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 79b32151..ae7b80cc 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -24,7 +24,7 @@
    • WorkerOptions
    +
  • Defined in src/worker/worker-options.ts:38
    • @@ -49,7 +49,7 @@

    Deprecated

    This option will be removed in the next major version.

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

    • Optional killBehavior

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

    Default Value

    KillBehaviors.SOFT

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

    • Optional maxInactiveTime

    maxInactiveTime?: number
    @@ -81,7 +81,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/interfaces/WorkerStatistics.html b/docs/interfaces/WorkerStatistics.html index 43452092..4b4b933a 100644 --- a/docs/interfaces/WorkerStatistics.html +++ b/docs/interfaces/WorkerStatistics.html @@ -24,7 +24,7 @@
    • WorkerStatistics
    +
  • Defined in src/utility-types.ts:42
    • @@ -41,12 +41,12 @@

    elu

    elu: boolean
    +
  • Defined in src/utility-types.ts:44

    • runTime

    runTime: boolean
    +
  • Defined in src/utility-types.ts:43
    • diff --git a/docs/interfaces/WorkerUsage.html b/docs/interfaces/WorkerUsage.html index 7ae8c3da..e781893b 100644 --- a/docs/interfaces/WorkerUsage.html +++ b/docs/interfaces/WorkerUsage.html @@ -24,7 +24,7 @@
    • WorkerUsage
    +
  • Defined in src/pools/worker.ts:126
    • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:142

    • runTime

    runTime: MeasurementStatistics
    @@ -54,7 +54,7 @@
    +
  • Defined in src/pools/worker.ts:134

    • tasks

    tasks: TaskStatistics
    @@ -62,7 +62,7 @@
    +
  • Defined in src/pools/worker.ts:130

    • waitTime

    waitTime: MeasurementStatistics
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:138
    • diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index b8a22f02..364e9f83 100644 --- a/docs/types/ErrorHandler.html +++ b/docs/types/ErrorHandler.html @@ -40,7 +40,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:15
    • diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html index 1313444c..521f225e 100644 --- a/docs/types/ExitHandler.html +++ b/docs/types/ExitHandler.html @@ -40,7 +40,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:28
    • diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html index 95d8c1dc..3100d26d 100644 --- a/docs/types/KillBehavior.html +++ b/docs/types/KillBehavior.html @@ -20,7 +20,7 @@
    +
  • Defined in src/worker/worker-options.ts:18
    • diff --git a/docs/types/Measurement.html b/docs/types/Measurement.html index 5a916bea..1ccf3d49 100644 --- a/docs/types/Measurement.html +++ b/docs/types/Measurement.html @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:56
    • diff --git a/docs/types/MessageHandler.html b/docs/types/MessageHandler.html index c4aa1ee4..9093e0c0 100644 --- a/docs/types/MessageHandler.html +++ b/docs/types/MessageHandler.html @@ -40,7 +40,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:7
    • diff --git a/docs/types/OnlineHandler.html b/docs/types/OnlineHandler.html index bf52b00b..7cd3c163 100644 --- a/docs/types/OnlineHandler.html +++ b/docs/types/OnlineHandler.html @@ -38,7 +38,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:23
    • diff --git a/docs/types/PoolEvent.html b/docs/types/PoolEvent.html index 4de3f20e..bd883491 100644 --- a/docs/types/PoolEvent.html +++ b/docs/types/PoolEvent.html @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/pool.ts:65
    • diff --git a/docs/types/PoolType.html b/docs/types/PoolType.html index 0a4fb6b8..26c59364 100644 --- a/docs/types/PoolType.html +++ b/docs/types/PoolType.html @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/pool.ts:32
    • diff --git a/docs/types/TaskFunctions.html b/docs/types/TaskFunctions.html index 13be9b94..0e99c07a 100644 --- a/docs/types/TaskFunctions.html +++ b/docs/types/TaskFunctions.html @@ -36,7 +36,7 @@ The value is the function itself.

    +
  • Defined in src/worker/worker-functions.ts:42
    • diff --git a/docs/types/WorkerAsyncFunction.html b/docs/types/WorkerAsyncFunction.html index fcb6764f..7d34daf3 100644 --- a/docs/types/WorkerAsyncFunction.html +++ b/docs/types/WorkerAsyncFunction.html @@ -47,7 +47,7 @@ This function must return a promise.

    Returns Promise<Response>

    +
  • Defined in src/worker/worker-functions.ts:18
    • diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index ac1951c2..89003773 100644 --- a/docs/types/WorkerChoiceStrategy.html +++ b/docs/types/WorkerChoiceStrategy.html @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:42
    • diff --git a/docs/types/WorkerFunction.html b/docs/types/WorkerFunction.html index 9053db9e..bfb89d51 100644 --- a/docs/types/WorkerFunction.html +++ b/docs/types/WorkerFunction.html @@ -34,7 +34,7 @@ This function can be synchronous or asynchronous.

    +
  • Defined in src/worker/worker-functions.ts:29
    • diff --git a/docs/types/WorkerSyncFunction.html b/docs/types/WorkerSyncFunction.html index d74a02e6..3c1eedad 100644 --- a/docs/types/WorkerSyncFunction.html +++ b/docs/types/WorkerSyncFunction.html @@ -46,7 +46,7 @@

    Returns Response

    +
  • Defined in src/worker/worker-functions.ts:7
    • diff --git a/docs/types/WorkerType.html b/docs/types/WorkerType.html index f04561b9..2d6aee09 100644 --- a/docs/types/WorkerType.html +++ b/docs/types/WorkerType.html @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/pool.ts:45
    • diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html index c1376949..3e22fda0 100644 --- a/docs/variables/KillBehaviors.html +++ b/docs/variables/KillBehaviors.html @@ -33,7 +33,7 @@
    +
  • Defined in src/worker/worker-options.ts:4
    • diff --git a/docs/variables/Measurements.html b/docs/variables/Measurements.html index 5295b9fe..6e4f87ec 100644 --- a/docs/variables/Measurements.html +++ b/docs/variables/Measurements.html @@ -29,7 +29,7 @@
    Readonly waitTime: "waitTime"
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:47
    • diff --git a/docs/variables/PoolEvents.html b/docs/variables/PoolEvents.html index 71e800fa..027f241b 100644 --- a/docs/variables/PoolEvents.html +++ b/docs/variables/PoolEvents.html @@ -31,7 +31,7 @@
    Readonly taskError: "taskError"
    +
  • Defined in src/pools/pool.ts:55
    • diff --git a/docs/variables/PoolTypes.html b/docs/variables/PoolTypes.html index 589a00a5..05b5fc48 100644 --- a/docs/variables/PoolTypes.html +++ b/docs/variables/PoolTypes.html @@ -33,7 +33,7 @@
    +
  • Defined in src/pools/pool.ts:18
    • diff --git a/docs/variables/WorkerChoiceStrategies.html b/docs/variables/WorkerChoiceStrategies.html index 551abd78..44856076 100644 --- a/docs/variables/WorkerChoiceStrategies.html +++ b/docs/variables/WorkerChoiceStrategies.html @@ -58,7 +58,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
    • diff --git a/docs/variables/WorkerTypes.html b/docs/variables/WorkerTypes.html index e7697ea5..0fd3f80b 100644 --- a/docs/variables/WorkerTypes.html +++ b/docs/variables/WorkerTypes.html @@ -27,7 +27,7 @@
    Readonly thread: "thread"
    +
  • Defined in src/pools/pool.ts:37
    • -- 2.34.1