From 134c1944c69547534c725e2ba8ee40fc5dacf147 Mon Sep 17 00:00:00 2001 From: Documentation Bot Date: Mon, 18 Sep 2023 11:19:48 +0000 Subject: [PATCH] docs: generate documentation --- docs/classes/AbstractPool.html | 180 +++++++++--------- docs/classes/AbstractWorker.html | 74 +++---- docs/classes/CircularArray.html | 22 +-- docs/classes/ClusterWorker.html | 48 ++--- docs/classes/Deque.html | 32 ++-- docs/classes/DynamicClusterPool.html | 92 ++++----- docs/classes/DynamicThreadPool.html | 92 ++++----- docs/classes/FixedClusterPool.html | 92 ++++----- docs/classes/FixedThreadPool.html | 92 ++++----- docs/classes/Node.html | 10 +- docs/classes/PoolEmitter.html | 2 +- docs/classes/ThreadWorker.html | 50 ++--- docs/classes/WorkerChoiceStrategyContext.html | 26 +-- docs/functions/availableParallelism.html | 2 +- docs/interfaces/ClusterPoolOptions.html | 28 +-- ...tLoopUtilizationMeasurementStatistics.html | 8 +- docs/interfaces/IPool.html | 26 +-- docs/interfaces/IWorker.html | 10 +- docs/interfaces/IWorkerChoiceStrategy.html | 16 +- docs/interfaces/IWorkerNode.html | 38 ++-- docs/interfaces/MeasurementOptions.html | 4 +- docs/interfaces/MeasurementStatistics.html | 14 +- .../MeasurementStatisticsRequirements.html | 8 +- docs/interfaces/MessageValue.html | 30 +-- docs/interfaces/PoolInfo.html | 44 ++--- docs/interfaces/PoolOptions.html | 24 +-- docs/interfaces/PromiseResponseWrapper.html | 8 +- docs/interfaces/StrategyData.html | 4 +- docs/interfaces/StrategyPolicy.html | 6 +- docs/interfaces/Task.html | 14 +- docs/interfaces/TaskError.html | 8 +- docs/interfaces/TaskPerformance.html | 10 +- docs/interfaces/TaskStatistics.html | 14 +- .../TaskStatisticsRequirements.html | 8 +- docs/interfaces/TasksQueueOptions.html | 10 +- docs/interfaces/ThreadPoolOptions.html | 26 +-- .../WorkerChoiceStrategyOptions.html | 14 +- docs/interfaces/WorkerInfo.html | 12 +- docs/interfaces/WorkerOptions.html | 10 +- 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/KillHandler.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/TaskAsyncFunction.html | 2 +- docs/types/TaskFunction.html | 2 +- docs/types/TaskFunctions.html | 2 +- docs/types/TaskSyncFunction.html | 2 +- docs/types/WorkerChoiceStrategy.html | 2 +- docs/types/WorkerNodeEventCallback.html | 2 +- docs/types/WorkerType.html | 2 +- docs/types/Writable.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 +- 64 files changed, 635 insertions(+), 635 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 19f0f6a1..de299a1e 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -49,7 +49,7 @@ +
  • Defined in src/pools/abstract-pool.ts:59
    • @@ -195,7 +195,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Optional Readonly max

    max?: number
    @@ -232,7 +232,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:92

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Private Readonly startTimestamp

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

    • Private started

    started: boolean
    @@ -277,7 +277,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:97

    • Private starting

    starting: boolean
    @@ -285,7 +285,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:101

    • Protected workerChoiceStrategyContext

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

    • Readonly Internal workerNodes

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

    • Accessors

    @@ -316,7 +316,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected Abstract type

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

    • Private utilization

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

    • Protected Abstract worker

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

    • Methods

    @@ -432,7 +432,7 @@

    Throws

    https://nodejs.org/api/errors.html#class-error If the added worker node is not found.

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

    • Protected afterTaskExecutionHook

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitDynamicWorkerCreationEvents

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

    • Private checkAndEmitTaskExecutionEvents

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

    • Private checkAndEmitTaskQueuingEvents

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

    • Protected checkDynamicPoolSize

    Returns void

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

    • Private checkFilePath

    Returns void

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

    • Private checkMessageWorkerId

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorkerNode

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

    • enableTasksQueue

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

    • Private enqueueTask

    Returns number

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

    • execute

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

    • Private executeTask

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

    • Protected flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    • Protected getWorkerInfo

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

    • Private getWorkerNodeKeyByWorker

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

    • Private getWorkerNodeKeyByWorkerId

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

    • Private handleTaskExecutionResponse

    Returns void

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

    • Private handleWorkerReadyResponse

    Returns void

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

    • Private hasBackPressure

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

    • hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • listTaskFunctions

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

    • Private redistributeQueuedTasks

    Returns void

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

    • Protected Abstract registerWorkerMessageListener

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

    • Private removeWorkerNode

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

    • Protected sendKillMessageToWorker

    Returns Promise<void>

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

    • Protected Abstract sendStartupMessageToWorker

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

    • Private sendStatisticsMessageToWorker

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

    • Protected Abstract sendToWorker

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

    • Private setTaskStealing

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

    • setTasksQueueOptions

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

    • Private setTasksQueueSize

    Returns void

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

    • Private setTasksStealingOnBackPressure

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

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

    • Private shallExecuteTask

    Returns boolean

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

    • Private shallUpdateTaskFunctionWorkerUsage

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

    • start

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

    • Private taskStealingOnEmptyQueue

    Returns void

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

    • Private tasksQueueSize

    Returns number

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

    • Private tasksStealingOnBackPressure

    Returns void

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

    • Private unsetTaskStealing

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

    • Private unsetTasksStealingOnBackPressure

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

    • Private updateEluWorkerUsage

    Returns void

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

    • Private updateRunTimeWorkerUsage

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

    Returns void

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

    • Private updateTaskStolenStatisticsWorkerUsage

    Returns void

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

    • Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1372
    • diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index c17d1cd8..597f0599 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -47,7 +47,7 @@
  • ClusterWorker
  • ThreadWorker
    • +
  • Defined in src/worker/abstract-worker.ts:49
    • @@ -154,7 +154,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:83

    • Properties

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

    • Protected Abstract id

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

    • Protected Readonly isMain

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

    • Protected lastTaskTimestamp

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

    • Private Readonly mainWorker

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

    • Protected opts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
    @@ -204,7 +204,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:88

    • Protected statistics

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

    • Protected taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -220,7 +220,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:61

    • Methods

    @@ -254,7 +254,7 @@ If a task function with the same name already exists, it is replaced.

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.

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

    • asyncId

    Returns TaskPerformance

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

    • bind

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

    • Private checkMessageWorkerId

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

    • Private checkStatistics

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

    • Private checkTaskFunctionName

    Returns void

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

    • Private checkTaskFunctions

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

    • Private checkValidTaskFunctionEntry

    Returns void

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

    • Private checkWorkerOptions

    Returns void

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

    • emitDestroy

    Returns TaskPerformance

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

    • Protected getMainWorker

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

    • Protected handleError

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

    • Protected handleKillMessage

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

    • Protected Abstract handleReadyMessage

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

    • hasTaskFunction

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

    • listTaskFunctions

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

    • Protected messageListener

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

    • removeTaskFunction

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • Protected sendTaskFunctionsListToMainWorker

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

    • Protected Abstract sendToMainWorker

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

    • setDefaultTaskFunction

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

    • Private startCheckActive

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

    • Private stopCheckActive

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

    • triggerAsyncId

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

    • Static bind

    +
  • Defined in src/circular-array.ts:10
    • @@ -113,7 +113,7 @@

    Returns CircularArray<T>

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

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

    • Static Readonly [species]

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

    • concat

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

    • copyWithin

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

    • entries

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

    • includes

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

    • reduce

    Returns void

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

    • reverse

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

    • toLocaleString

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

    • values

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

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

    • Properties

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

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

    • Protected Readonly isMain

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

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

    • Protected lastTaskTimestamp

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

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

    • Protected opts

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

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

    • Protected statistics

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

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

    • Protected taskFunctions

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

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

    • Accessors

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

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

    • Methods

    @@ -232,7 +232,7 @@ If a task function with the same name already exists, it is replaced.

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

    • asyncId

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

    • Protected handleError

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

    • Protected handleKillMessage

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

    • Protected handleReadyMessage

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

    • hasTaskFunction

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

    • listTaskFunctions

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

    • Protected messageListener

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

    • removeTaskFunction

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

    • Protected run

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • Protected sendTaskFunctionsListToMainWorker

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

    • Protected sendToMainWorker

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

    • setDefaultTaskFunction

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

    • triggerAsyncId

    +
  • Defined in src/deque.ts:26
    • @@ -77,14 +77,14 @@ Implemented with a doubly linked list.

    T

    Returns Deque<T>

    +
  • Defined in src/deque.ts:34

    • Properties

    Private Optional head

    head?: Node<T>
    +
  • Defined in src/deque.ts:27

    • maxSize

    maxSize: number
    @@ -92,7 +92,7 @@ Implemented with a doubly linked list.

    +
  • Defined in src/deque.ts:32

    • size

    size: number
    @@ -100,12 +100,12 @@ Implemented with a doubly linked list.

    +
  • Defined in src/deque.ts:30

    • Private Optional tail

    tail?: Node<T>
    +
  • Defined in src/deque.ts:28

    • Methods

    @@ -121,7 +121,7 @@ Implemented with a doubly linked list.

    See

    https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols

    +
  • Defined in src/deque.ts:144

    • backward

    +
  • Defined in src/deque.ts:170

    • clear

    +
  • Defined in src/deque.ts:131

    • Private incrementSize

    +
  • Defined in src/deque.ts:194

    • peekFirst

    +
  • Defined in src/deque.ts:116

    • peekLast

    +
  • Defined in src/deque.ts:124

    • pop

    +
  • Defined in src/deque.ts:77

    • push

    +
  • Defined in src/deque.ts:44

    • shift

    +
  • Defined in src/deque.ts:97

    • unshift

    +
  • Defined in src/deque.ts:61
    • diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 13cbf3ba..dabffa52 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    • DynamicClusterPool
    +
  • Defined in src/pools/cluster/dynamic.ts:15
    • @@ -151,7 +151,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

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

    • Protected Readonly filePath

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

    • Protected Readonly max

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly Internal workerNodes

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

    • Accessors

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctions

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

    • Protected registerWorkerMessageListener

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

    • Protected sendKillMessageToWorker

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • start

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1372
    • diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 0a4b9b6a..3a4aa6d6 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
    • @@ -151,7 +151,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

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

    • Protected Readonly filePath

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

    • Protected Readonly max

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly Internal workerNodes

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

    • Accessors

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctions

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

    • Protected registerWorkerMessageListener

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

    • Protected sendKillMessageToWorker

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • start

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1372
    • diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index b3e3d114..554a0e72 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
    • @@ -146,7 +146,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Optional Readonly max

    max?: number
    @@ -185,7 +185,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:92

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly Internal workerNodes

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

    • Accessors

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctions

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

    • Protected registerWorkerMessageListener

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

    • Protected sendKillMessageToWorker

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • start

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1372
    • diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 3ea66d2b..cd9db074 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -45,7 +45,7 @@ +
  • Defined in src/pools/thread/fixed.ts:35
    • @@ -146,7 +146,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:46

    • Properties

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

    • Protected Readonly filePath

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

    • Protected Optional Readonly max

    max?: number
    @@ -185,7 +185,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:92

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

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

    • Protected workerChoiceStrategyContext

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

    • Readonly Internal workerNodes

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

    • Accessors

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected type

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

    • Private utilization

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

    • Protected worker

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

    • Methods

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

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Protected checkDynamicPoolSize

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected createWorker

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

    • destroy

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

    • Protected destroyWorkerNode

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

    • enableTasksQueue

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

    • execute

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

    • Protected flushTasksQueue

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

    • Protected getWorkerInfo

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

    • hasWorkerNodeBackPressure

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

    • Protected internalBusy

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

    • Protected isMain

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

    • listTaskFunctions

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

    • Protected registerWorkerMessageListener

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

    • Protected sendKillMessageToWorker

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

    • Protected sendStartupMessageToWorker

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

    • Protected sendToWorker

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

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • start

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

    • Protected workerListener

    +
  • Defined in src/pools/abstract-pool.ts:1372
    • diff --git a/docs/classes/Node.html b/docs/classes/Node.html index f1e5b0ca..fefa64b6 100644 --- a/docs/classes/Node.html +++ b/docs/classes/Node.html @@ -32,7 +32,7 @@
    • Node
    +
  • Defined in src/deque.ts:9
    • @@ -67,24 +67,24 @@
    data: T

    Returns Node<T>

    +
  • Defined in src/deque.ts:14

    • Properties

    data

    data: T
    +
  • Defined in src/deque.ts:10

    • Optional next

    next?: Node<T>
    +
  • Defined in src/deque.ts:11

    • Optional prev

    prev?: Node<T>
    +
  • Defined in src/deque.ts:12
    • diff --git a/docs/classes/PoolEmitter.html b/docs/classes/PoolEmitter.html index d6fb7cf6..7de50189 100644 --- a/docs/classes/PoolEmitter.html +++ b/docs/classes/PoolEmitter.html @@ -26,7 +26,7 @@
    • PoolEmitter
    +
  • Defined in src/pools/pool.ts:39
    • diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index c89e1a46..86a1da14 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
    • @@ -128,7 +128,7 @@ but the minimum number of workers will be guaranteed.

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

    • Properties

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

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

    • Protected Readonly isMain

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

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

    • Protected lastTaskTimestamp

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

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

    • Protected opts

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

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

    • Private port

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

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

    • Protected statistics

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

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

    • Protected taskFunctions

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

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

    • Accessors

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

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

    • Methods

    @@ -241,7 +241,7 @@ If a task function with the same name already exists, it is replaced.

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

    • asyncId

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

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

    • Protected handleError

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

    • Protected handleKillMessage

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

    • Protected handleReadyMessage

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

    • hasTaskFunction

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

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

    • listTaskFunctions

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

    • Protected messageListener

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

    • removeTaskFunction

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

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

    • Protected run

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

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

    • Protected runAsync

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

    • runInAsyncScope

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

    • Protected sendTaskFunctionsListToMainWorker

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

    • Protected sendToMainWorker

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

    • setDefaultTaskFunction

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

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

    • triggerAsyncId

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:27
    • @@ -108,7 +108,7 @@

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

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

    • Properties

    @@ -118,7 +118,7 @@
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:52

    • Private retriesCount

    retriesCount: number = 0
    @@ -126,12 +126,12 @@
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:40

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

    • Methods

    @@ -155,7 +155,7 @@

    Throws

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

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

    • getStrategyPolicy

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

    • getTaskStatisticsRequirements

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

    • remove

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

    • setOptions

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

    • setWorkerChoiceStrategy

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

    • update

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:159
    • diff --git a/docs/functions/availableParallelism.html b/docs/functions/availableParallelism.html index 372d8286..7e27ef96 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:56
    • diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 451b3e56..e939ddf0 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -26,7 +26,7 @@
    • ClusterPoolOptions
    +
  • Defined in src/pools/cluster/fixed.ts:10
    • @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/pool.ts:185

    • Optional enableTasksQueue

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

    • Optional env

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

    See

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

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

    • Optional errorHandler

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

    • Optional exitHandler

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

    • Optional messageHandler

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

    • Optional onlineHandler

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

    • Optional restartWorkerOnError

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

    • Optional settings

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

    See

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

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

    • Optional startWorkers

    startWorkers?: boolean
    @@ -158,7 +158,7 @@
    +
  • Defined in src/pools/pool.ts:165

    • Optional tasksQueueOptions

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

    • Optional workerChoiceStrategy

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

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -188,7 +188,7 @@
    +
  • Defined in src/pools/pool.ts:175
    • diff --git a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html index 54758755..d2bcb673 100644 --- a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html +++ b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html @@ -24,7 +24,7 @@
    • EventLoopUtilizationMeasurementStatistics
    +
  • Defined in src/pools/worker.ts:71
    • @@ -42,17 +42,17 @@

    Readonly active

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

    • Readonly idle

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

    • Optional utilization

    utilization?: number
    +
  • Defined in src/pools/worker.ts:74
    • diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index ff7878f0..51ef02e2 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:205
    • @@ -84,7 +84,7 @@

    Returns Promise<void>

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

    • Optional Readonly emitter

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

    • Readonly enableTasksQueue

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

    Returns void

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

    • Readonly execute

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

    • Readonly hasWorkerNodeBackPressure

    hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    @@ -191,7 +191,7 @@
    +
  • Defined in src/pools/pool.ts:227

    • Readonly info

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

    • Readonly listTaskFunctions

    listTaskFunctions: (() => string[])
    @@ -216,7 +216,7 @@
    +
  • Defined in src/pools/pool.ts:268

    • Readonly setTasksQueueOptions

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

    Returns void

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

    • Readonly setWorkerChoiceStrategy

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

    Returns void

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

    • Readonly setWorkerChoiceStrategyOptions

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

    Returns void

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

    • Readonly start

    start: (() => void)
    @@ -309,7 +309,7 @@

    Returns void

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

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]
    @@ -317,7 +317,7 @@
    +
  • Defined in src/pools/pool.ts:219
    • diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index e006efd4..5d87b3ea 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -24,7 +24,7 @@
    • IWorker
    +
  • Defined in src/pools/worker.ts:186
    • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:190

    • Readonly 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:198

    • Readonly once

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

    Returns void

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

    • Optional Readonly threadId

    threadId?: number
    +
  • Defined in src/pools/worker.ts:191
    • diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 153e6513..8db4d707 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:168
    • @@ -59,7 +59,7 @@ If the worker node is not eligible, undefined is returned.

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

    • Readonly remove

    remove: ((workerNodeKey) => boolean)
    @@ -84,7 +84,7 @@ If the worker node is not eligible, undefined is returned.

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

    • Readonly reset

    reset: (() => boolean)
    @@ -101,7 +101,7 @@ If the worker node is not eligible, undefined is returned.

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

    • Readonly setOptions

    setOptions: ((opts) => void)
    @@ -125,7 +125,7 @@ If the worker node is not eligible, undefined is returned.

    Returns void

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

    • Readonly strategyPolicy

    strategyPolicy: StrategyPolicy
    @@ -133,7 +133,7 @@ If the worker node is not eligible, undefined is returned.

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

    • Readonly taskStatisticsRequirements

    taskStatisticsRequirements: TaskStatisticsRequirements
    @@ -141,7 +141,7 @@ If the worker node is not eligible, undefined is returned.

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

    • Readonly update

    update: ((workerNodeKey) => boolean)
    @@ -163,7 +163,7 @@ If the worker node is not eligible, undefined is returned.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:188
    • diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index ff963f6c..83f2cfbf 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -37,7 +37,7 @@
    • IWorkerNode
    +
  • Defined in src/pools/worker.ts:226
    • @@ -81,7 +81,7 @@

    Returns void

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

    • Readonly closeChannel

    closeChannel: (() => void)
    @@ -97,7 +97,7 @@

    Returns void

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

    • Readonly dequeueTask

    dequeueTask: (() => undefined | Task<Data>)
    @@ -114,7 +114,7 @@
    +
  • Defined in src/pools/worker.ts:286

    • Readonly enqueueTask

    enqueueTask: ((task) => number)
    @@ -139,7 +139,7 @@
    +
  • Defined in src/pools/worker.ts:273

    • Readonly getTaskFunctionWorkerUsage

    getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/worker.ts:317

    • Readonly hasBackPressure

    hasBackPressure: (() => boolean)
    @@ -181,7 +181,7 @@
    +
  • Defined in src/pools/worker.ts:302

    • Readonly info

    info: WorkerInfo
    @@ -189,7 +189,7 @@
    +
  • Defined in src/pools/worker.ts:234

    • Optional Readonly messageChannel

    messageChannel?: MessageChannel
    @@ -197,7 +197,7 @@
    +
  • Defined in src/pools/worker.ts:247

    • Optional onBackPressure

    onBackPressure?: WorkerNodeEventCallback
    @@ -205,7 +205,7 @@
    +
  • Defined in src/pools/worker.ts:256

    • Optional onEmptyQueue

    onEmptyQueue?: WorkerNodeEventCallback
    @@ -213,7 +213,7 @@
    +
  • Defined in src/pools/worker.ts:260

    • Readonly popTask

    popTask: (() => undefined | Task<Data>)
    @@ -230,7 +230,7 @@
    +
  • Defined in src/pools/worker.ts:292

    • Readonly resetUsage

    resetUsage: (() => void)
    @@ -246,7 +246,7 @@

    Returns void

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

    • Optional strategyData

    strategyData?: StrategyData
    @@ -255,7 +255,7 @@ This is used to store data that is specific to the worker choice strategy.

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

    • tasksQueueBackPressureSize

    tasksQueueBackPressureSize: number
    @@ -264,7 +264,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:252

    • Readonly tasksQueueSize

    tasksQueueSize: (() => number)
    @@ -281,7 +281,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:266

    • Readonly unshiftTask

    unshiftTask: ((task) => number)
    @@ -306,7 +306,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:280

    • Readonly usage

    usage: WorkerUsage
    @@ -314,7 +314,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:238

    • Readonly worker

    worker: Worker
    @@ -322,7 +322,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:230
    • diff --git a/docs/interfaces/MeasurementOptions.html b/docs/interfaces/MeasurementOptions.html index 2a1ce020..61b7b741 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:59
    • @@ -43,7 +43,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:63
    • diff --git a/docs/interfaces/MeasurementStatistics.html b/docs/interfaces/MeasurementStatistics.html index fc20f48e..6ba42ddf 100644 --- a/docs/interfaces/MeasurementStatistics.html +++ b/docs/interfaces/MeasurementStatistics.html @@ -24,7 +24,7 @@
    • MeasurementStatistics
    +
  • Defined in src/pools/worker.ts:39
    • @@ -48,7 +48,7 @@
    +
  • Defined in src/pools/worker.ts:43

    • Optional average

    average?: number
    @@ -56,7 +56,7 @@
    +
  • Defined in src/pools/worker.ts:55

    • Readonly history

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

    • Optional maximum

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

    • Optional median

    median?: number
    @@ -80,7 +80,7 @@
    +
  • Defined in src/pools/worker.ts:59

    • Optional minimum

    minimum?: number
    @@ -88,7 +88,7 @@
    +
  • Defined in src/pools/worker.ts:47
    • diff --git a/docs/interfaces/MeasurementStatisticsRequirements.html b/docs/interfaces/MeasurementStatisticsRequirements.html index b053ffab..dcbd0bde 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:112
    • @@ -45,7 +45,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:116

    • average

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

    • median

    median: boolean
    @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:124
    • diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 7ff77765..e7d99c08 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -39,7 +39,7 @@
    • MessageValue
    +
  • Defined in src/utility-types.ts:105
    • @@ -71,7 +71,7 @@
    +
  • Defined in src/utility-types.ts:134

    • Optional Readonly data

    data?: Data
    @@ -80,7 +80,7 @@
    +
  • Defined in src/utility-types.ts:83

    • Optional Readonly kill

    kill?: true | "success" | "SOFT" | "HARD" | "failure"
    @@ -88,7 +88,7 @@
    +
  • Defined in src/utility-types.ts:110

    • Optional Readonly name

    name?: string
    @@ -97,7 +97,7 @@
    +
  • Defined in src/utility-types.ts:79

    • Optional Readonly port

    port?: MessagePort
    @@ -105,7 +105,7 @@
    +
  • Defined in src/utility-types.ts:138

    • Optional Readonly ready

    ready?: boolean
    @@ -113,7 +113,7 @@
    +
  • Defined in src/utility-types.ts:130

    • Optional Readonly statistics

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

    • Optional Readonly taskError

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

    • Optional Readonly taskFunctions

    taskFunctions?: string[]
    @@ -137,7 +137,7 @@
    +
  • Defined in src/utility-types.ts:122

    • Optional Readonly taskId

    taskId?: string
    @@ -146,7 +146,7 @@
    +
  • Defined in src/utility-types.ts:95

    • Optional Readonly taskPerformance

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

    • Optional Readonly timestamp

    timestamp?: number
    @@ -163,7 +163,7 @@
    +
  • Defined in src/utility-types.ts:91

    • Optional Readonly transferList

    transferList?: TransferListItem[]
    @@ -172,7 +172,7 @@
    +
  • Defined in src/utility-types.ts:87

    • Readonly workerId

    workerId: number
    @@ -181,7 +181,7 @@
    +
  • Defined in src/utility-types.ts:75
    • diff --git a/docs/interfaces/PoolInfo.html b/docs/interfaces/PoolInfo.html index 751f399b..31a2e3a0 100644 --- a/docs/interfaces/PoolInfo.html +++ b/docs/interfaces/PoolInfo.html @@ -24,7 +24,7 @@
    • PoolInfo
    +
  • Defined in src/pools/pool.ts:62
    • @@ -60,7 +60,7 @@

    Optional Readonly backPressure

    backPressure?: boolean
    +
  • Defined in src/pools/pool.ts:83

    • Readonly busyWorkerNodes

    busyWorkerNodes: number
    @@ -68,22 +68,22 @@
    +
  • Defined in src/pools/pool.ts:78

    • Readonly executedTasks

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

    • Readonly executingTasks

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

    • Readonly failedTasks

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

    • Readonly idleWorkerNodes

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

    • Optional Readonly maxQueuedTasks

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

    • Readonly maxSize

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

    • Readonly minSize

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

    • Optional Readonly queuedTasks

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

    • Readonly ready

    ready: boolean
    +
  • Defined in src/pools/pool.ts:67

    • Optional Readonly runTime

    runTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }
    @@ -132,27 +132,27 @@
  • Readonly minimum: number
    • +
  • Defined in src/pools/pool.ts:86

    • Readonly started

    started: boolean
    +
  • Defined in src/pools/pool.ts:66

    • Optional Readonly stolenTasks

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

    • Readonly strategy

    strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    +
  • Defined in src/pools/pool.ts:68

    • Readonly type

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

    • Optional Readonly utilization

    utilization?: number
    @@ -160,12 +160,12 @@
    +
  • Defined in src/pools/pool.ts:72

    • Readonly version

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

    • Optional Readonly waitTime

    waitTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }
    @@ -181,12 +181,12 @@
  • Readonly minimum: number
    • +
  • Defined in src/pools/pool.ts:92

    • Readonly worker

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

    • Readonly workerNodes

    workerNodes: number
    @@ -194,7 +194,7 @@
    +
  • Defined in src/pools/pool.ts:74
    • diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 6288456b..288cf760 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -35,7 +35,7 @@
  • ClusterPoolOptions
  • ThreadPoolOptions
    • +
  • Defined in src/pools/pool.ts:135
    • @@ -67,7 +67,7 @@
    +
  • Defined in src/pools/pool.ts:185

    • Optional enableTasksQueue

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

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>
    @@ -88,7 +88,7 @@

    Default Value

    () => {}

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

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>
    @@ -98,7 +98,7 @@

    Default Value

    () => {}

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

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>
    @@ -108,7 +108,7 @@

    Default Value

    () => {}

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

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>
    @@ -118,7 +118,7 @@

    Default Value

    () => {}

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

    • Optional restartWorkerOnError

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

    • Optional startWorkers

    startWorkers?: boolean
    @@ -137,7 +137,7 @@
    +
  • Defined in src/pools/pool.ts:165

    • Optional tasksQueueOptions

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

    • Optional workerChoiceStrategy

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

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/pool.ts:175
    • diff --git a/docs/interfaces/PromiseResponseWrapper.html b/docs/interfaces/PromiseResponseWrapper.html index 506981f4..3194d6de 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -32,7 +32,7 @@
    • PromiseResponseWrapper
    +
  • Defined in src/utility-types.ts:147
    • @@ -66,7 +66,7 @@

    Returns void

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

    • Readonly resolve

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

    Returns void

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

    • Readonly workerNodeKey

    workerNodeKey: number
    @@ -95,7 +95,7 @@
    +
  • Defined in src/utility-types.ts:159
    • diff --git a/docs/interfaces/StrategyData.html b/docs/interfaces/StrategyData.html index 1116ec79..e2246ad5 100644 --- a/docs/interfaces/StrategyData.html +++ b/docs/interfaces/StrategyData.html @@ -24,7 +24,7 @@
    • StrategyData
    +
  • Defined in src/pools/worker.ts:179
    • @@ -40,7 +40,7 @@

    Optional virtualTaskEndTimestamp

    virtualTaskEndTimestamp?: number
    +
  • Defined in src/pools/worker.ts:180
    • diff --git a/docs/interfaces/StrategyPolicy.html b/docs/interfaces/StrategyPolicy.html index 51a66cb6..83ff1c13 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:152
    • @@ -44,7 +44,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:160

    • Readonly dynamicWorkerUsage

    dynamicWorkerUsage: boolean
    @@ -52,7 +52,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:156
    • diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index 79c66611..dd634999 100644 --- a/docs/interfaces/Task.html +++ b/docs/interfaces/Task.html @@ -34,7 +34,7 @@ +
  • Defined in src/utility-types.ts:71
    • @@ -58,7 +58,7 @@
    +
  • Defined in src/utility-types.ts:83

    • Optional Readonly name

    name?: string
    @@ -66,7 +66,7 @@
    +
  • Defined in src/utility-types.ts:79

    • Optional Readonly taskId

    taskId?: string
    @@ -74,7 +74,7 @@
    +
  • Defined in src/utility-types.ts:95

    • Optional Readonly timestamp

    timestamp?: number
    @@ -82,7 +82,7 @@
    +
  • Defined in src/utility-types.ts:91

    • Optional Readonly transferList

    transferList?: TransferListItem[]
    @@ -90,7 +90,7 @@
    +
  • Defined in src/utility-types.ts:87

    • Readonly workerId

    workerId: number
    @@ -98,7 +98,7 @@
    +
  • Defined in src/utility-types.ts:75
    • diff --git a/docs/interfaces/TaskError.html b/docs/interfaces/TaskError.html index f03d1972..a40ce993 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 name

    name: string
    @@ -69,7 +69,7 @@
    +
  • Defined in src/utility-types.ts:14
    • diff --git a/docs/interfaces/TaskPerformance.html b/docs/interfaces/TaskPerformance.html index 8b7c8be2..a0b4f60c 100644 --- a/docs/interfaces/TaskPerformance.html +++ b/docs/interfaces/TaskPerformance.html @@ -24,7 +24,7 @@
    • TaskPerformance
    +
  • Defined in src/utility-types.ts:30
    • @@ -46,7 +46,7 @@
    +
  • Defined in src/utility-types.ts:46

    • Readonly name

    name: string
    @@ -54,7 +54,7 @@
    +
  • Defined in src/utility-types.ts:34

    • Optional Readonly runTime

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

    • Readonly timestamp

    timestamp: number
    @@ -70,7 +70,7 @@
    +
  • Defined in src/utility-types.ts:38
    • diff --git a/docs/interfaces/TaskStatistics.html b/docs/interfaces/TaskStatistics.html index 1fb3f872..23ce8722 100644 --- a/docs/interfaces/TaskStatistics.html +++ b/docs/interfaces/TaskStatistics.html @@ -24,7 +24,7 @@
    • TaskStatistics
    +
  • Defined in src/pools/worker.ts:82
    • @@ -48,7 +48,7 @@
    +
  • Defined in src/pools/worker.ts:86

    • executing

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

    • failed

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

    • Optional Readonly maxQueued

    maxQueued?: number
    @@ -72,7 +72,7 @@
    +
  • Defined in src/pools/worker.ts:98

    • Readonly queued

    queued: number
    @@ -80,7 +80,7 @@
    +
  • Defined in src/pools/worker.ts:94

    • stolen

    stolen: number
    @@ -88,7 +88,7 @@
    +
  • Defined in src/pools/worker.ts:102
    • diff --git a/docs/interfaces/TaskStatisticsRequirements.html b/docs/interfaces/TaskStatisticsRequirements.html index 4beba8b0..c2c71687 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:132
    • @@ -45,7 +45,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:144

    • Readonly runTime

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

    • Readonly waitTime

    waitTime: MeasurementStatisticsRequirements
    @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:140
    • diff --git a/docs/interfaces/TasksQueueOptions.html b/docs/interfaces/TasksQueueOptions.html index 418b5f26..a464031a 100644 --- a/docs/interfaces/TasksQueueOptions.html +++ b/docs/interfaces/TasksQueueOptions.html @@ -24,7 +24,7 @@
    • TasksQueueOptions
    +
  • Defined in src/pools/pool.ts:103
    • @@ -49,7 +49,7 @@
    +
  • Defined in src/pools/pool.ts:115

    • Optional Readonly size

    size?: number
    @@ -60,7 +60,7 @@
    +
  • Defined in src/pools/pool.ts:109

    • Optional Readonly taskStealing

    taskStealing?: boolean
    @@ -71,7 +71,7 @@
    +
  • Defined in src/pools/pool.ts:121

    • Optional Readonly tasksStealingOnBackPressure

    tasksStealingOnBackPressure?: boolean
    @@ -82,7 +82,7 @@
    +
  • Defined in src/pools/pool.ts:127
    • diff --git a/docs/interfaces/ThreadPoolOptions.html b/docs/interfaces/ThreadPoolOptions.html index 0b7b527d..b95c00f5 100644 --- a/docs/interfaces/ThreadPoolOptions.html +++ b/docs/interfaces/ThreadPoolOptions.html @@ -26,7 +26,7 @@
    • ThreadPoolOptions
    +
  • Defined in src/pools/thread/fixed.ts:18
    • @@ -60,7 +60,7 @@
    +
  • Defined in src/pools/pool.ts:185

    • Optional enableTasksQueue

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

    • Optional errorHandler

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

    • Optional exitHandler

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

    • Optional messageHandler

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

    • Optional onlineHandler

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

    • Optional restartWorkerOnError

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

    • Optional startWorkers

    startWorkers?: boolean
    @@ -137,7 +137,7 @@
    +
  • Defined in src/pools/pool.ts:165

    • Optional tasksQueueOptions

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

    • Optional workerChoiceStrategy

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

    • Optional workerChoiceStrategyOptions

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

    • Optional workerOptions

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

    See

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

    +
  • Defined in src/pools/thread/fixed.ts:24
    • diff --git a/docs/interfaces/WorkerChoiceStrategyOptions.html b/docs/interfaces/WorkerChoiceStrategyOptions.html index b95f6179..8e1a9792 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:69
    • @@ -51,7 +51,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:97

    • Optional Readonly measurement

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

    • Optional Readonly retries

    retries?: number
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:75

    • Optional Readonly runTime

    runTime?: MeasurementOptions
    @@ -81,7 +81,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:85

    • Optional Readonly waitTime

    waitTime?: MeasurementOptions
    @@ -92,7 +92,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:91

    • Optional Readonly weights

    weights?: Record<number, number>
    @@ -104,7 +104,7 @@ A weight is tasks maximum execution time in milliseconds for a worker node.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:104
    • diff --git a/docs/interfaces/WorkerInfo.html b/docs/interfaces/WorkerInfo.html index c635e2eb..a595bc94 100644 --- a/docs/interfaces/WorkerInfo.html +++ b/docs/interfaces/WorkerInfo.html @@ -24,7 +24,7 @@
    • WorkerInfo
    +
  • Defined in src/pools/worker.ts:127
    • @@ -47,7 +47,7 @@
    +
  • Defined in src/pools/worker.ts:139

    • Readonly id

    id: undefined | number
    @@ -55,7 +55,7 @@
    +
  • Defined in src/pools/worker.ts:131

    • ready

    ready: boolean
    @@ -63,7 +63,7 @@
    +
  • Defined in src/pools/worker.ts:143

    • Optional taskFunctions

    taskFunctions?: string[]
    @@ -71,7 +71,7 @@
    +
  • Defined in src/pools/worker.ts:147

    • Readonly type

    type: "thread" | "cluster"
    @@ -79,7 +79,7 @@
    +
  • Defined in src/pools/worker.ts:135
    • diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index d010e203..6e5bc60b 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -24,7 +24,7 @@
    • WorkerOptions
    +
  • Defined in src/worker/worker-options.ts:28
    • @@ -51,7 +51,7 @@

    Deprecated

    This option will be removed in the next major version.

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

    • Optional killBehavior

    killBehavior?: "SOFT" | "HARD"
    @@ -67,7 +67,7 @@
    +
  • Defined in src/worker/worker-options.ts:39

    • Optional killHandler

    killHandler?: KillHandler
    @@ -77,7 +77,7 @@

    Default Value

    () => {}

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

    • Optional maxInactiveTime

    maxInactiveTime?: number
    @@ -95,7 +95,7 @@ when this timeout expires your tasks is interrupted before completion and remove
    +
  • Defined in src/worker/worker-options.ts:52
    • diff --git a/docs/interfaces/WorkerStatistics.html b/docs/interfaces/WorkerStatistics.html index 6a161ace..981da43f 100644 --- a/docs/interfaces/WorkerStatistics.html +++ b/docs/interfaces/WorkerStatistics.html @@ -24,7 +24,7 @@
    • WorkerStatistics
    +
  • Defined in src/utility-types.ts:54
    • @@ -44,7 +44,7 @@
    +
  • Defined in src/utility-types.ts:62

    • Readonly runTime

    runTime: boolean
    @@ -52,7 +52,7 @@
    +
  • Defined in src/utility-types.ts:58
    • diff --git a/docs/interfaces/WorkerUsage.html b/docs/interfaces/WorkerUsage.html index 68f166d4..00a94853 100644 --- a/docs/interfaces/WorkerUsage.html +++ b/docs/interfaces/WorkerUsage.html @@ -24,7 +24,7 @@
    • WorkerUsage
    +
  • Defined in src/pools/worker.ts:155
    • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:171

    • Readonly runTime

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

    • Readonly tasks

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

    • Readonly waitTime

    waitTime: MeasurementStatistics
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:167
    • diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index be31e986..9679da46 100644 --- a/docs/types/ErrorHandler.html +++ b/docs/types/ErrorHandler.html @@ -40,7 +40,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:21
    • diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html index 8cc2c616..88646845 100644 --- a/docs/types/ExitHandler.html +++ b/docs/types/ExitHandler.html @@ -40,7 +40,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:29
    • diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html index 94fe51e6..af4cb8cc 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/KillHandler.html b/docs/types/KillHandler.html index b99d525c..92a85436 100644 --- a/docs/types/KillHandler.html +++ b/docs/types/KillHandler.html @@ -28,7 +28,7 @@

    Returns void | Promise<void>

    +
  • Defined in src/worker/worker-options.ts:23
    • diff --git a/docs/types/Measurement.html b/docs/types/Measurement.html index 8f942478..f441a7f0 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:54
    • diff --git a/docs/types/MessageHandler.html b/docs/types/MessageHandler.html index 0c52fd8b..b4691a2a 100644 --- a/docs/types/MessageHandler.html +++ b/docs/types/MessageHandler.html @@ -40,7 +40,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:13
    • diff --git a/docs/types/OnlineHandler.html b/docs/types/OnlineHandler.html index 4d7601a7..90a342c6 100644 --- a/docs/types/OnlineHandler.html +++ b/docs/types/OnlineHandler.html @@ -38,7 +38,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:8
    • diff --git a/docs/types/PoolEvent.html b/docs/types/PoolEvent.html index 221f0891..003b8d47 100644 --- a/docs/types/PoolEvent.html +++ b/docs/types/PoolEvent.html @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/pool.ts:57
    • diff --git a/docs/types/PoolType.html b/docs/types/PoolType.html index edfcda40..4d8cc58e 100644 --- a/docs/types/PoolType.html +++ b/docs/types/PoolType.html @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/pool.ts:34
    • diff --git a/docs/types/TaskAsyncFunction.html b/docs/types/TaskAsyncFunction.html index 40ed3aca..b43d39f3 100644 --- a/docs/types/TaskAsyncFunction.html +++ b/docs/types/TaskAsyncFunction.html @@ -47,7 +47,7 @@ This function must return a promise.

    Returns Promise<Response>

    +
  • Defined in src/worker/task-functions.ts:18
    • diff --git a/docs/types/TaskFunction.html b/docs/types/TaskFunction.html index 0f50d95b..116f51b2 100644 --- a/docs/types/TaskFunction.html +++ b/docs/types/TaskFunction.html @@ -34,7 +34,7 @@ This function can be synchronous or asynchronous.

    +
  • Defined in src/worker/task-functions.ts:29
    • diff --git a/docs/types/TaskFunctions.html b/docs/types/TaskFunctions.html index a9adb85d..b94c4c7d 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/task-functions.ts:42
    • diff --git a/docs/types/TaskSyncFunction.html b/docs/types/TaskSyncFunction.html index c4ccffa0..7f3eed5e 100644 --- a/docs/types/TaskSyncFunction.html +++ b/docs/types/TaskSyncFunction.html @@ -46,7 +46,7 @@

    Returns Response

    +
  • Defined in src/worker/task-functions.ts:7
    • diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index e60810de..0a7e8884 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:40
    • diff --git a/docs/types/WorkerNodeEventCallback.html b/docs/types/WorkerNodeEventCallback.html index d515cf38..550012f4 100644 --- a/docs/types/WorkerNodeEventCallback.html +++ b/docs/types/WorkerNodeEventCallback.html @@ -36,7 +36,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:217
    • diff --git a/docs/types/WorkerType.html b/docs/types/WorkerType.html index 103e4172..cbc7ccee 100644 --- a/docs/types/WorkerType.html +++ b/docs/types/WorkerType.html @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/worker.ts:120
    • diff --git a/docs/types/Writable.html b/docs/types/Writable.html index ffb8f711..83011882 100644 --- a/docs/types/Writable.html +++ b/docs/types/Writable.html @@ -22,7 +22,7 @@

  • T

    • +
  • Defined in src/utility-types.ts:162
    • diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html index 3b1419b5..6370c105 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 b9201d39..6e5acb18 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:45
    • diff --git a/docs/variables/PoolEvents.html b/docs/variables/PoolEvents.html index a08f54e9..791eb548 100644 --- a/docs/variables/PoolEvents.html +++ b/docs/variables/PoolEvents.html @@ -37,7 +37,7 @@
    Readonly taskError: "taskError"
    +
  • Defined in src/pools/pool.ts:44
    • diff --git a/docs/variables/PoolTypes.html b/docs/variables/PoolTypes.html index 8e2eb5c6..e7510fe6 100644 --- a/docs/variables/PoolTypes.html +++ b/docs/variables/PoolTypes.html @@ -33,7 +33,7 @@
    +
  • Defined in src/pools/pool.ts:20
    • diff --git a/docs/variables/WorkerChoiceStrategies.html b/docs/variables/WorkerChoiceStrategies.html index c98d59cf..f1a673e6 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 2c232dac..0b9d578c 100644 --- a/docs/variables/WorkerTypes.html +++ b/docs/variables/WorkerTypes.html @@ -27,7 +27,7 @@
    Readonly thread: "thread"
    +
  • Defined in src/pools/worker.ts:112
    • -- 2.34.1