From 5497d426557f576e3ee314619f83b71685acc6bc Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 3 Jul 2023 21:47:30 +0000 Subject: [PATCH] chore: generate documentation --- docs/classes/AbstractPool.html | 138 +++++++++--------- docs/classes/AbstractWorker.html | 46 +++--- docs/classes/CircularArray.html | 22 +-- docs/classes/ClusterWorker.html | 34 ++--- docs/classes/DynamicClusterPool.html | 74 +++++----- docs/classes/DynamicThreadPool.html | 74 +++++----- docs/classes/FixedClusterPool.html | 72 ++++----- docs/classes/FixedThreadPool.html | 72 ++++----- docs/classes/PoolEmitter.html | 2 +- docs/classes/Queue.html | 20 +-- docs/classes/ThreadWorker.html | 34 ++--- docs/classes/WorkerChoiceStrategyContext.html | 22 +-- docs/functions/availableParallelism.html | 2 +- docs/interfaces/ClusterPoolOptions.html | 26 ++-- ...tLoopUtilizationMeasurementStatistics.html | 8 +- docs/interfaces/IPool.html | 20 +-- docs/interfaces/IWorker.html | 10 +- docs/interfaces/IWorkerChoiceStrategy.html | 16 +- docs/interfaces/MeasurementOptions.html | 4 +- docs/interfaces/MeasurementStatistics.html | 10 +- .../MeasurementStatisticsRequirements.html | 8 +- docs/interfaces/MessageValue.html | 22 +-- docs/interfaces/PoolInfo.html | 30 ++-- docs/interfaces/PoolOptions.html | 22 +-- docs/interfaces/PromiseResponseWrapper.html | 8 +- docs/interfaces/StrategyPolicy.html | 4 +- docs/interfaces/Task.html | 10 +- docs/interfaces/TaskError.html | 8 +- 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/WorkerInfo.html | 8 +- docs/interfaces/WorkerNode.html | 10 +- 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 +- 59 files changed, 484 insertions(+), 484 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 726fa79c..b2f77081 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -49,7 +49,7 @@ +
  • Defined in src/pools/abstract-pool.ts:50
    • @@ -174,7 +174,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Private Readonly startTimestamp

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

    @@ -268,7 +268,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected Abstract maxSize

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

    • Protected Abstract minSize

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

    • Private runTime

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

    • Protected Abstract type

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

    • Private utilization

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

    • Protected Abstract worker

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

    • Methods

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

    Returns void

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitEvents

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

    • Private checkFilePath

    Returns void

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorker

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

    Returns void

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

    • Private flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    • Private getWorkerById

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

    • Private getWorkerId

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

    • Private getWorkerNodeKey

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

    • Private getWorkerUsage

    Returns WorkerUsage

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

    • Private handleTaskExecutionResponse

    Returns void

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

    • Private handleWorkerStartedMessage

    Returns void

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • Private pushWorkerNode

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

    • Private registerWorkerMessageListener

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

    • Private removeWorkerNode

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

    • Protected Abstract sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Private setWorkerNodeTasksUsage

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

    • Private setWorkerStatistics

    Returns void

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

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

    • Private tasksMaxQueueSize

    Returns number

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

    • Private tasksQueueSize

    Returns number

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

    • Private updateEluWorkerUsage

    Returns void

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

    • Private updateRunTimeWorkerUsage

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

    Returns void

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

    • Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:853
    • diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 6fc6317e..00ab2f3d 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
    • @@ -140,7 +140,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:68

    • Properties

    @@ -150,7 +150,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:58

    • Protected Abstract id

    id: number
    @@ -158,7 +158,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:42

    • Protected Readonly isMain

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

    • Protected lastTaskTimestamp

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

    • Protected Readonly mainWorker

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

    • Protected Readonly opts

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

    • Protected statistics

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

    • Protected taskFunctions

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

    • Methods

    @@ -227,7 +227,7 @@

  • Returns TaskPerformance

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

    • bind

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

    • Private checkStatistics

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

    • Private checkTaskFunctions

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

    • Private checkWorkerOptions

    Returns void

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

    • emitDestroy

    Returns TaskPerformance

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

    • Protected getMainWorker

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

    • Private getTaskFunction

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • Protected Abstract sendToMainWorker

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

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

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

    • Properties

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

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

    • Protected Readonly isMain

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

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

    • Protected lastTaskTimestamp

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

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

    • Protected Readonly mainWorker

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

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

    • Protected Readonly opts

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

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

    • Protected statistics

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

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

    • Protected taskFunctions

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

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

    • Accessors

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

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

    • Methods

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

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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • Protected sendToMainWorker

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

    • triggerAsyncId

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

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

    • Protected Readonly filePath

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

    • Protected Readonly max

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

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -195,7 +195,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>> = ...
    @@ -209,7 +209,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:69

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private runTime

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:853
    • diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 118d63d4..903b53c4 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
    • @@ -142,7 +142,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

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

    • Protected Readonly filePath

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

    • Protected Readonly max

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

    • Protected Readonly opts

    opts: ThreadPoolOptions = {}
    @@ -195,7 +195,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>> = ...
    @@ -209,7 +209,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:69

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

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

    • info

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

    • Protected maxSize

      @@ -279,7 +279,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 +291,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/fixed.ts:91

    • Private runTime

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

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

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:853
    • diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index ba7d623b..34eaa0cd 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:38
    • @@ -136,7 +136,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:49

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private runTime

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:853
    • diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 5692b8d6..058611cb 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -45,7 +45,7 @@ +
  • Defined in src/pools/thread/fixed.ts:37
    • @@ -136,7 +136,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:48

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly workerNodes

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

    • Accessors

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private runTime

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorker

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

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:853
    • diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index 5f20158f..62bd8c6b 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 ddbcec04..bb106f14 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 e1edb527..c70431a4 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:26
    • @@ -120,7 +120,7 @@ but the minimum number of workers will be guaranteed.

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

    • Properties

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

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

    • Protected Readonly isMain

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

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

    • Protected lastTaskTimestamp

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

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

    • Protected Readonly mainWorker

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

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

    • Protected Readonly opts

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

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

    • Protected statistics

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

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

    • Protected taskFunctions

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

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

    • Accessors

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

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

    • Methods

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

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

    • emitDestroy

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

    • Protected handleError

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

    • Protected messageListener

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • Protected sendToMainWorker

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

    • triggerAsyncId

      diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 5c4e938e..983d414f 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 0827ca96..5d2ffbe6 100644 --- a/docs/functions/availableParallelism.html +++ b/docs/functions/availableParallelism.html @@ -26,7 +26,7 @@ Always returns a value greater than zero.

    +
  • Defined in src/utils.ts:41
    • diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 07d25f8f..9a182c09 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:144

    • Optional enableTasksQueue

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

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

    • Optional exitHandler

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

    • Optional messageHandler

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

    • Optional onlineHandler

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

    • Optional restartWorkerOnError

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

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

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

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/pool.ts:134
    • diff --git a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html index 5c3d69f3..5b8ce2f5 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 @@

    Readonly active

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

    • Readonly 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 99097bc6..80ced8c2 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:164
    • @@ -81,7 +81,7 @@

    Returns Promise<void>

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

    • Optional Readonly emitter

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

    • enableTasksQueue

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

    Returns void

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

    • execute

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

    • Readonly info

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

    • setTasksQueueOptions

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

    Returns void

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

    • setWorkerChoiceStrategy

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

    Returns void

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

    • setWorkerChoiceStrategyOptions

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

    Returns void

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

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[]
    @@ -248,7 +248,7 @@
    +
  • Defined in src/pools/pool.ts:176
    • diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index d625a860..b2214783 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -24,7 +24,7 @@
    • IWorker
    +
  • Defined in src/pools/worker.ts:168
    • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:172

    • on

    on: ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void)
    @@ -118,7 +118,7 @@

    Param

    The event handler.

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

    • once

    once: ((event, handler) => void)
    @@ -147,12 +147,12 @@

    Returns void

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

    • Optional Readonly threadId

    threadId?: number
    +
  • Defined in src/pools/worker.ts:173
    • diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index a154d2ff..b5c62372 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 c330aa57..60b6491c 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 35539067..0470512a 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

    • Readonly 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 2dc68adb..12e56c8e 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 7cb81194..bb14dd8b 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -39,7 +39,7 @@
    • MessageValue
    +
  • Defined in src/utility-types.ts:62
    • @@ -68,7 +68,7 @@
    +
  • Defined in src/pools/worker.ts:47

    • Optional Readonly id

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

    • Optional Readonly kill

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

    • Optional Readonly name

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

    • Optional Readonly started

    started?: boolean
    @@ -102,7 +102,7 @@
    +
  • Defined in src/utility-types.ts:87

    • Optional Readonly statistics

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

    • Optional Readonly taskError

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

    • Optional Readonly taskPerformance

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

    • Optional Readonly timestamp

    timestamp?: number
    @@ -135,7 +135,7 @@
    +
  • Defined in src/pools/worker.ts:51

    • Optional Readonly workerId

    workerId?: number
    @@ -143,7 +143,7 @@
    +
  • Defined in src/utility-types.ts:67
    • diff --git a/docs/interfaces/PoolInfo.html b/docs/interfaces/PoolInfo.html index 29386cda..480b5084 100644 --- a/docs/interfaces/PoolInfo.html +++ b/docs/interfaces/PoolInfo.html @@ -24,7 +24,7 @@
    • PoolInfo
    +
  • Defined in src/pools/pool.ts:70
    • @@ -56,22 +56,22 @@
    +
  • Defined in src/pools/pool.ts:83

    • executedTasks

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

    • executingTasks

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

    • failedTasks

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

    • idleWorkerNodes

    idleWorkerNodes: number
    @@ -79,32 +79,32 @@
    +
  • Defined in src/pools/pool.ts:81

    • maxQueuedTasks

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

    • maxSize

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

    • minSize

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

    • queuedTasks

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

    • type

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

    • Optional utilization

    utilization?: number
    @@ -112,17 +112,17 @@
    +
  • Defined in src/pools/pool.ts:77

    • version

    version: string
    +
  • Defined in src/pools/pool.ts:71

    • worker

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

    • workerNodes

    workerNodes: number
    @@ -130,7 +130,7 @@
    +
  • Defined in src/pools/pool.ts:79
    • diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index bf63c862..595c1494 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -35,7 +35,7 @@
  • ClusterPoolOptions
  • ThreadPoolOptions
    • +
  • Defined in src/pools/pool.ts:108
    • @@ -65,7 +65,7 @@

    Default Value

    true

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

    • Optional enableTasksQueue

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

    Default Value

    false

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

    • Optional errorHandler

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

    • Optional exitHandler

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

    • Optional messageHandler

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

    • Optional onlineHandler

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

    • Optional restartWorkerOnError

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

    • Optional tasksQueueOptions

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

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

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -141,7 +141,7 @@
    +
  • Defined in src/pools/pool.ts:134
    • diff --git a/docs/interfaces/PromiseResponseWrapper.html b/docs/interfaces/PromiseResponseWrapper.html index dad40fcc..52f018f4 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -37,7 +37,7 @@
    • PromiseResponseWrapper
    +
  • Defined in src/utility-types.ts:97
    • @@ -71,7 +71,7 @@

    Returns void

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

    • Readonly resolve

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

    Returns void

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

    • Readonly worker

    worker: Worker
    @@ -100,7 +100,7 @@
    +
  • Defined in src/utility-types.ts:112
    • diff --git a/docs/interfaces/StrategyPolicy.html b/docs/interfaces/StrategyPolicy.html index 9a3171e3..7e5177c1 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 a1f7c5bb..081381cc 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 1a38d0ac..28a5b96c 100644 --- a/docs/interfaces/TaskError.html +++ b/docs/interfaces/TaskError.html @@ -32,7 +32,7 @@
    • TaskError
    +
  • Defined in src/utility-types.ts:10
    • @@ -53,7 +53,7 @@
    +
  • Defined in src/utility-types.ts:22

    • Readonly message

    message: string
    @@ -61,7 +61,7 @@
    +
  • Defined in src/utility-types.ts:18

    • Readonly workerId

    workerId: number
    @@ -69,7 +69,7 @@
    +
  • Defined in src/utility-types.ts:14
    • diff --git a/docs/interfaces/TaskPerformance.html b/docs/interfaces/TaskPerformance.html index 42e3e16b..83ed5926 100644 --- a/docs/interfaces/TaskPerformance.html +++ b/docs/interfaces/TaskPerformance.html @@ -24,7 +24,7 @@
    • TaskPerformance
    +
  • Defined in src/utility-types.ts:30
    • @@ -45,7 +45,7 @@
    +
  • Defined in src/utility-types.ts:42

    • Optional Readonly runTime

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

    • Readonly timestamp

    timestamp: number
    @@ -61,7 +61,7 @@
    +
  • Defined in src/utility-types.ts:34
    • diff --git a/docs/interfaces/TaskStatistics.html b/docs/interfaces/TaskStatistics.html index 9b95dc50..cfc76f76 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 7d9e92bf..ee0f4af4 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

    • Readonly runTime

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

    • Readonly 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 33b02a14..d80d2a46 100644 --- a/docs/interfaces/TasksQueueOptions.html +++ b/docs/interfaces/TasksQueueOptions.html @@ -24,7 +24,7 @@
    • TasksQueueOptions
    +
  • Defined in src/pools/pool.ts:94
    • @@ -45,7 +45,7 @@

    Default Value

    1

    +
  • Defined in src/pools/pool.ts:100
    • diff --git a/docs/interfaces/ThreadPoolOptions.html b/docs/interfaces/ThreadPoolOptions.html index 0d2250b6..7b7a0013 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:144

    • Optional enableTasksQueue

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

    • Optional errorHandler

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

    • Optional exitHandler

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

    • Optional messageHandler

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

    • Optional onlineHandler

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

    • Optional restartWorkerOnError

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

    • Optional tasksQueueOptions

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

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

    • Optional workerChoiceStrategyOptions

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

    • 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 907da32f..8fbf8a17 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 Readonly measurement

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

    • Optional Readonly runTime

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

    Default Value

    { median: false }

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

    • Optional Readonly waitTime

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

    Default Value

    { median: false }

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

    • Optional Readonly 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/WorkerInfo.html b/docs/interfaces/WorkerInfo.html index 5dfd6645..ed91995a 100644 --- a/docs/interfaces/WorkerInfo.html +++ b/docs/interfaces/WorkerInfo.html @@ -24,7 +24,7 @@
    • WorkerInfo
    +
  • Defined in src/pools/worker.ts:126
    • @@ -45,7 +45,7 @@
    +
  • Defined in src/pools/worker.ts:130

    • Optional Readonly sharedBuffer

    sharedBuffer?: Int32Array
    @@ -53,7 +53,7 @@
    +
  • Defined in src/pools/worker.ts:138

    • started

    started: boolean
    @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/worker.ts:134
    • diff --git a/docs/interfaces/WorkerNode.html b/docs/interfaces/WorkerNode.html index c9c15fab..4aac141c 100644 --- a/docs/interfaces/WorkerNode.html +++ b/docs/interfaces/WorkerNode.html @@ -37,7 +37,7 @@
    • WorkerNode
    +
  • Defined in src/pools/worker.ts:200
    • @@ -59,7 +59,7 @@
    +
  • Defined in src/pools/worker.ts:208

    • Readonly tasksQueue

    tasksQueue: Queue<Task<Data>>
    @@ -67,7 +67,7 @@
    +
  • Defined in src/pools/worker.ts:216

    • usage

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

    • Readonly worker

    worker: Worker
    @@ -83,7 +83,7 @@
    +
  • Defined in src/pools/worker.ts:204
    • diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 8123464e..e4ffc66d 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -24,7 +24,7 @@
    • WorkerOptions
    +
  • Defined in src/worker/worker-options.ts:23
    • @@ -49,7 +49,7 @@

    Deprecated

    This option will be removed in the next major version.

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

    • Optional killBehavior

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

    Default Value

    KillBehaviors.SOFT

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

    • 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:36
    • diff --git a/docs/interfaces/WorkerStatistics.html b/docs/interfaces/WorkerStatistics.html index be08bb63..da0c5e1d 100644 --- a/docs/interfaces/WorkerStatistics.html +++ b/docs/interfaces/WorkerStatistics.html @@ -24,7 +24,7 @@
    • WorkerStatistics
    +
  • Defined in src/utility-types.ts:50
    • @@ -41,12 +41,12 @@

    elu

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

    • runTime

    runTime: boolean
    +
  • Defined in src/utility-types.ts:51
    • diff --git a/docs/interfaces/WorkerUsage.html b/docs/interfaces/WorkerUsage.html index b2eab809..df836a69 100644 --- a/docs/interfaces/WorkerUsage.html +++ b/docs/interfaces/WorkerUsage.html @@ -24,7 +24,7 @@
    • WorkerUsage
    +
  • Defined in src/pools/worker.ts:146
    • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:162

    • Readonly runTime

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

    • Readonly tasks

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

    • Readonly waitTime

    waitTime: MeasurementStatistics
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:158
    • diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index 1150aaca..bd9263ab 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 ffec6798..b309dfac 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 0f50be02..30b49faa 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 82617082..f6d4d313 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 91ba35d6..dd50d46c 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 7ac37829..d0b178de 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 c3a1e892..45f9e994 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 df7d01b8..6d854045 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 8a8b8e8e..18039cad 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 feb68c9a..4abc4c13 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 ed592d05..8b09bdcc 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 340388c6..ee9b5a37 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 87e1dcac..70484876 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 3c634bb0..d406dd76 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 117f6a8b..a52d039c 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 4d7aaf87..412d6df1 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 1f41b15e..ef649f1c 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 784e4565..1db5dab8 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 7768d8f1..175e7dab 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 99e85c0b..048c0456 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