From 5e5a659e2b415c7d533dad095eda082989983f8e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 9 Jun 2023 19:54:12 +0000 Subject: [PATCH] chore: generate documentation --- docs/classes/AbstractPool.html | 119 +++++++++--------- docs/classes/AbstractWorker.html | 42 +++---- docs/classes/CircularArray.html | 22 ++-- docs/classes/ClusterWorker.html | 32 ++--- docs/classes/DynamicClusterPool.html | 73 ++++++----- docs/classes/DynamicThreadPool.html | 73 ++++++----- docs/classes/FixedClusterPool.html | 72 ++++++----- docs/classes/FixedThreadPool.html | 72 ++++++----- docs/classes/PoolEmitter.html | 2 +- docs/classes/Queue.html | 22 ++-- docs/classes/ThreadWorker.html | 32 ++--- docs/classes/WorkerChoiceStrategyContext.html | 20 +-- docs/interfaces/ClusterPoolOptions.html | 26 ++-- ...tLoopUtilizationMeasurementStatistics.html | 8 +- docs/interfaces/IPool.html | 20 +-- docs/interfaces/IWorker.html | 6 +- docs/interfaces/IWorkerChoiceStrategy.html | 14 +-- docs/interfaces/MeasurementOptions.html | 4 +- docs/interfaces/MeasurementStatistics.html | 10 +- .../MeasurementStatisticsRequirements.html | 8 +- docs/interfaces/MessageValue.html | 20 +-- docs/interfaces/PoolInfo.html | 26 ++-- docs/interfaces/PoolOptions.html | 22 ++-- docs/interfaces/PromiseResponseWrapper.html | 8 +- docs/interfaces/Task.html | 10 +- docs/interfaces/TaskError.html | 6 +- docs/interfaces/TaskPerformance.html | 8 +- docs/interfaces/TaskStatistics.html | 10 +- .../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/Draft.html | 2 +- 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 +- .../types/ThreadWorkerWithMessageChannel.html | 2 +- docs/types/WorkerAsyncFunction.html | 2 +- docs/types/WorkerChoiceStrategy.html | 2 +- docs/types/WorkerFunction.html | 2 +- docs/types/WorkerSyncFunction.html | 2 +- docs/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, 452 insertions(+), 459 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 01b34541..002878a8 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -49,7 +49,7 @@ +
  • Defined in src/pools/abstract-pool.ts:45
    • @@ -164,7 +164,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -219,16 +219,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:64

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Default to a round robin algorithm.

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

    • Readonly workerNodes

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

    • Accessors

    @@ -251,7 +250,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected Abstract maxSize

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

    • Protected Abstract minSize

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

    • Protected Abstract type

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

    • Protected Abstract worker

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

    • Methods

    @@ -347,7 +346,7 @@ Can be overridden.

    Returns void

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

    • Protected Abstract afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    • Private checkFilePath

    Returns void

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    • Private getTaskStatistics

    Returns TaskStatistics

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

    • Private getWorkerNodeKey

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

    • Private getWorkerUsage

    Returns WorkerUsage

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

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

    • Protected Abstract registerWorkerMessageListener

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

    • Private removeWorkerNode

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

    • Protected Abstract sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Private setWorkerNodeTasksUsage

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

    • Private setWorkerStatistics

    Returns void

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

    • Protected setupHook

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

    • Private tasksQueueSize

    Returns number

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

    • Private updateEluWorkerUsage

    Returns void

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

    • Private updateRunTimeWorkerUsage

    Returns void

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

    • Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:705
    • diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 40e49558..37736c80 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
    • @@ -138,7 +138,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:64

    • Properties

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

    • Protected Readonly isMain

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

    • Protected lastTaskTimestamp

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

    • Protected mainWorker

    mainWorker: undefined | null | MainWorker
    @@ -172,7 +172,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:70

    • Protected Readonly opts

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

    • Protected statistics

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

    • Protected taskFunctions

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

    • Methods

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

  • Returns TaskPerformance

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

    • bind

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

    • Private checkTaskFunctions

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

    • Private checkWorkerOptions

    Returns void

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

    • emitDestroy

    Returns TaskPerformance

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

    • Protected getMainWorker

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

    • Private getTaskFunction

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • Protected Abstract sendToMainWorker

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

    • triggerAsyncId

    +
  • 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
    +
  • Defined in src/circular-array.ts:88

    • concat

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

    • copyWithin

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

    • entries

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

    • includes

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

    • reduce

    Returns void

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

    • reverse

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

    • toLocaleString

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

    • values

    +
  • Defined in src/worker/cluster-worker.ts: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 mainWorker

    mainWorker: undefined | null | 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

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

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

    • emitDestroy

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

    • Protected handleError

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

    • runInAsyncScope

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

    • Protected sendToMainWorker

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

    • triggerAsyncId

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

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

    • Protected Readonly filePath

    filePath: string
    @@ -168,7 +168,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 max

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Default to a round robin algorithm.

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

    • Readonly workerNodes

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

    • Accessors

    @@ -242,7 +241,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

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Protected type

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

    • Protected worker

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

    • Methods

    @@ -344,7 +343,7 @@ Can be overridden.

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected registerWorkerMessageListener

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:705
    • diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index a1a2ae7d..cbbc5b2d 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
    • @@ -141,7 +141,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

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

    • Protected Readonly filePath

    filePath: string
    @@ -168,7 +168,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 max

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Default to a round robin algorithm.

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

    • Readonly workerNodes

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

    • Accessors

    @@ -242,7 +241,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

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

    • info

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

    • Protected maxSize

      @@ -279,7 +278,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

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

    • Protected type

      @@ -304,7 +303,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

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

    • Methods

    @@ -344,7 +343,7 @@ Can be overridden.

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected registerWorkerMessageListener

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:705
    • diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 3f181781..0fa2836c 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -18,7 +18,6 @@

    A cluster pool with a fixed number of workers.

    It is possible to perform tasks in sync or asynchronous mode as you prefer.

    -

    This pool selects the workers in a round robin fashion.

    Author

    Christopher Quadflieg

    @@ -47,7 +46,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:40
    • @@ -137,7 +136,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:51

    • Properties

    @@ -155,7 +154,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:54

    • Protected Readonly filePath

    filePath: string
    @@ -164,7 +163,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:87

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -173,7 +172,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:86

    • Protected Readonly opts

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

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -196,17 +195,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:64

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Default to a round robin algorithm.

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

    • Readonly workerNodes

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

    • Accessors

    @@ -230,7 +228,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:120

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Protected type

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

    • Protected worker

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

    • Methods

    @@ -332,7 +330,7 @@ Can be overridden.

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected registerWorkerMessageListener

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:705
    • diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index b1f5eaf9..2504bffc 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -18,7 +18,6 @@

    A thread pool with a fixed number of threads.

    It is possible to perform tasks in sync or asynchronous mode as you prefer.

    -

    This pool selects the threads in a round robin fashion.

    Author

    Alessandro Pio Ardizio

    @@ -47,7 +46,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:45
    • @@ -137,7 +136,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:56

    • Properties

    @@ -155,7 +154,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:54

    • Protected Readonly filePath

    filePath: string
    @@ -164,7 +163,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:87

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -173,7 +172,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:86

    • Protected Readonly opts

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

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -196,17 +195,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:64

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Default to a round robin algorithm.

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

    • Readonly workerNodes

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

    • Accessors

    @@ -230,7 +228,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:132

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Protected type

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

    • Protected worker

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

    • Methods

    @@ -332,7 +330,7 @@ Can be overridden.

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected chooseWorkerNode

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

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

    • Protected registerWorkerMessageListener

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:705
    • diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index 782aae85..22344ed8 100644 --- a/docs/classes/PoolEmitter.html +++ b/docs/classes/PoolEmitter.html @@ -26,7 +26,7 @@
    • PoolEmitter
    +
  • Defined in src/pools/pool.ts:50
    • diff --git a/docs/classes/Queue.html b/docs/classes/Queue.html index 159d2eca..d490ca6e 100644 --- a/docs/classes/Queue.html +++ b/docs/classes/Queue.html @@ -32,7 +32,7 @@
    • Queue
    +
  • Defined in src/queue.ts:8
    • @@ -74,29 +74,29 @@

    T

    Returns Queue<T>

    +
  • Defined in src/queue.ts:14

    • Properties

    Private head

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

    • Private items

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

    • Private max

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

    • Private tail

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

    • Accessors

    @@ -110,7 +110,7 @@
    +
  • Defined in src/queue.ts:37

    • size

    +
  • Defined in src/queue.ts:27

    • Methods

    @@ -136,7 +136,7 @@
    +
  • Defined in src/queue.ts:59

    • enqueue

    +
  • Defined in src/queue.ts:47

    • peek

    +
  • Defined in src/queue.ts:75
    • diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 9e51fae2..553669d1 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 mainWorker

    mainWorker: undefined | null | 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

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

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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • Protected sendToMainWorker

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

    • triggerAsyncId

      diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 266dff95..33de0dad 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:26
    • @@ -105,14 +105,14 @@

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

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

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

    • Private workerChoiceStrategy

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

    • Methods

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

    • getTaskStatisticsRequirements

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

    • remove

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

    • setOptions

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

    • setWorkerChoiceStrategy

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

    • update

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:139
    • diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 0d3d9730..37d02860 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 9ef0d81d..4893229a 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 d9423ad5..6ad17b4c 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 901ecf5c..31520e66 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -24,7 +24,7 @@
    • IWorker
    +
  • Defined in src/pools/worker.ts:144
    • @@ -108,7 +108,7 @@

    Param

    The event handler.

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

    • once

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

    Returns void

    +
  • Defined in src/pools/worker.ts:161
    • diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index be964d02..2f483047 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:146
    • @@ -57,7 +57,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:168

    • remove

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

    • reset

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

    • setOptions

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

    Returns void

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

    • Readonly taskStatisticsRequirements

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

    • update

    update: ((workerNodeKey) => boolean)
    @@ -153,7 +153,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:162
    • diff --git a/docs/interfaces/MeasurementOptions.html b/docs/interfaces/MeasurementOptions.html index 8455308b..a958597b 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 0c0c1a95..3f74e4f6 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 7fdd4e35..decda27a 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 09ae76d7..b623323a 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -44,7 +44,7 @@
    • MessageValue
    +
  • Defined in src/utility-types.ts:64
    • @@ -72,7 +72,7 @@
    +
  • Defined in src/pools/worker.ts:47

    • Optional Readonly id

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

    • Optional Readonly kill

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

    • Optional Readonly name

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

    • Optional Readonly parent

    parent?: MainWorker
    @@ -106,7 +106,7 @@
    +
  • Defined in src/utility-types.ts:84

    • Optional Readonly statistics

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

    • Optional Readonly taskError

    taskError?: TaskError<Data>
    @@ -122,7 +122,7 @@
    +
  • Defined in src/utility-types.ts:76

    • Optional Readonly taskPerformance

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

    • Optional Readonly timestamp

    timestamp?: number
    @@ -139,7 +139,7 @@
    +
  • Defined in src/pools/worker.ts:51
    • diff --git a/docs/interfaces/PoolInfo.html b/docs/interfaces/PoolInfo.html index d1c2c314..7729859c 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 ef3eb965..40f4af82 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 6e07e7a9..c28addd9 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -37,7 +37,7 @@
    • PromiseResponseWrapper
    +
  • Defined in src/utility-types.ts:98
    • @@ -71,7 +71,7 @@

    Returns void

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

    • Readonly resolve

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

    Returns void

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

    • Readonly worker

    worker: Worker
    @@ -100,7 +100,7 @@
    +
  • Defined in src/utility-types.ts:113
    • diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index 2ab54f27..c71d013f 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 69300266..604b1832 100644 --- a/docs/interfaces/TaskError.html +++ b/docs/interfaces/TaskError.html @@ -32,7 +32,7 @@
    • TaskError
    +
  • Defined in src/utility-types.ts:19
    • @@ -52,7 +52,7 @@
    +
  • Defined in src/utility-types.ts:27

    • message

    message: string
    @@ -60,7 +60,7 @@
    +
  • Defined in src/utility-types.ts:23
    • diff --git a/docs/interfaces/TaskPerformance.html b/docs/interfaces/TaskPerformance.html index 57b7e8b2..752545bf 100644 --- a/docs/interfaces/TaskPerformance.html +++ b/docs/interfaces/TaskPerformance.html @@ -24,7 +24,7 @@
    • TaskPerformance
    +
  • Defined in src/utility-types.ts:33
    • @@ -45,7 +45,7 @@
    +
  • Defined in src/utility-types.ts:45

    • Optional runTime

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

    • timestamp

    timestamp: number
    @@ -61,7 +61,7 @@
    +
  • Defined in src/utility-types.ts:37
    • diff --git a/docs/interfaces/TaskStatistics.html b/docs/interfaces/TaskStatistics.html index 7dfd76cc..6f9c5483 100644 --- a/docs/interfaces/TaskStatistics.html +++ b/docs/interfaces/TaskStatistics.html @@ -24,7 +24,7 @@
    • TaskStatistics
    +
  • Defined in src/pools/worker.ts:98
    • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:102

    • executing

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

    • failed

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

    • Readonly queued

    queued: number
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:110
    • diff --git a/docs/interfaces/TaskStatisticsRequirements.html b/docs/interfaces/TaskStatisticsRequirements.html index 61c2fa37..dfc33126 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 fa6c2f9e..fa5ae52b 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 e5925848..1ca958fc 100644 --- a/docs/interfaces/ThreadPoolOptions.html +++ b/docs/interfaces/ThreadPoolOptions.html @@ -26,7 +26,7 @@
    • ThreadPoolOptions
    +
  • Defined in src/pools/thread/fixed.ts:21
    • @@ -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:27
    • diff --git a/docs/interfaces/WorkerChoiceStrategyOptions.html b/docs/interfaces/WorkerChoiceStrategyOptions.html index ca9ade50..f582fd14 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 3acf03b8..1d8e54f8 100644 --- a/docs/interfaces/WorkerNode.html +++ b/docs/interfaces/WorkerNode.html @@ -37,7 +37,7 @@
    • WorkerNode
    +
  • Defined in src/pools/worker.ts:171
    • @@ -58,7 +58,7 @@
    +
  • Defined in src/pools/worker.ts:183

    • Readonly worker

    worker: Worker
    @@ -66,7 +66,7 @@
    +
  • Defined in src/pools/worker.ts:175

    • workerUsage

    workerUsage: WorkerUsage
    @@ -74,7 +74,7 @@
    +
  • Defined in src/pools/worker.ts:179
    • diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 07feba0d..baef6088 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 fa38959f..e4f99006 100644 --- a/docs/interfaces/WorkerStatistics.html +++ b/docs/interfaces/WorkerStatistics.html @@ -24,7 +24,7 @@
    • WorkerStatistics
    +
  • Defined in src/utility-types.ts:51
    • @@ -41,12 +41,12 @@

    elu

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

    • runTime

    runTime: boolean
    +
  • Defined in src/utility-types.ts:52
    • diff --git a/docs/interfaces/WorkerUsage.html b/docs/interfaces/WorkerUsage.html index 6371a5b3..06ad63c3 100644 --- a/docs/interfaces/WorkerUsage.html +++ b/docs/interfaces/WorkerUsage.html @@ -24,7 +24,7 @@
    • WorkerUsage
    +
  • Defined in src/pools/worker.ts:122
    • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:138

    • runTime

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

    • tasks

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

    • waitTime

    waitTime: MeasurementStatistics
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:134
    • diff --git a/docs/types/Draft.html b/docs/types/Draft.html index 6a09859b..181d0922 100644 --- a/docs/types/Draft.html +++ b/docs/types/Draft.html @@ -28,7 +28,7 @@
    +
  • Defined in src/utility-types.ts:12
    • diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index 497be3e9..e0ef1141 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 5515278d..15280d13 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 c02864cc..9bc7a147 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 ec55f4e9..7ae51d48 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 618cf111..4a2bfbcd 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 c0955545..7612bb86 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 cda4edf7..79beb380 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 47ecf0ec..32cd0136 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 88e71500..216d81f6 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/ThreadWorkerWithMessageChannel.html b/docs/types/ThreadWorkerWithMessageChannel.html index f403a3cf..4f16b11d 100644 --- a/docs/types/ThreadWorkerWithMessageChannel.html +++ b/docs/types/ThreadWorkerWithMessageChannel.html @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:33
    • diff --git a/docs/types/WorkerAsyncFunction.html b/docs/types/WorkerAsyncFunction.html index 38c3ffc4..9433df1d 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 d2075e20..fbf72261 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 4d233104..218a1a88 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 60ef60fb..0de4c0fd 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 a51c1502..393440ef 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 749f446b..4ede05ac 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 ba4dddc2..b076944a 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 f06dcea2..004ddd7e 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 50827a1d..7c1ce72e 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 1c91cde7..72b910dc 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 19b6bb07..a69dad9a 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