From 95c333666812f5db34b93c20d8851f2755d1c920 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 24 Aug 2023 10:38:35 +0000 Subject: [PATCH] chore: generate documentation --- docs/classes/AbstractPool.html | 168 +++++++++--------- docs/classes/AbstractWorker.html | 74 ++++---- docs/classes/CircularArray.html | 24 +-- docs/classes/ClusterWorker.html | 48 ++--- docs/classes/Deque.html | 34 ++-- docs/classes/DynamicClusterPool.html | 90 +++++----- docs/classes/DynamicThreadPool.html | 90 +++++----- docs/classes/FixedClusterPool.html | 90 +++++----- docs/classes/FixedThreadPool.html | 90 +++++----- docs/classes/Node.html | 12 +- docs/classes/PoolEmitter.html | 2 +- docs/classes/ThreadWorker.html | 50 +++--- docs/classes/WorkerChoiceStrategyContext.html | 26 +-- docs/functions/availableParallelism.html | 4 +- docs/interfaces/ClusterPoolOptions.html | 26 +-- ...tLoopUtilizationMeasurementStatistics.html | 8 +- docs/interfaces/IPool.html | 24 +-- docs/interfaces/IWorker.html | 10 +- docs/interfaces/IWorkerChoiceStrategy.html | 16 +- docs/interfaces/IWorkerNode.html | 36 ++-- docs/interfaces/MeasurementOptions.html | 4 +- docs/interfaces/MeasurementStatistics.html | 14 +- .../MeasurementStatisticsRequirements.html | 8 +- docs/interfaces/MessageValue.html | 30 ++-- docs/interfaces/PoolInfo.html | 40 ++--- docs/interfaces/PoolOptions.html | 22 +-- docs/interfaces/PromiseResponseWrapper.html | 8 +- docs/interfaces/StrategyPolicy.html | 6 +- docs/interfaces/Task.html | 14 +- docs/interfaces/TaskError.html | 8 +- docs/interfaces/TaskPerformance.html | 10 +- docs/interfaces/TaskStatistics.html | 12 +- .../TaskStatisticsRequirements.html | 8 +- docs/interfaces/TasksQueueOptions.html | 8 +- docs/interfaces/ThreadPoolOptions.html | 24 +-- .../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/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 +- 62 files changed, 617 insertions(+), 617 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 22404f94..ae49d8ab 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -49,7 +49,7 @@ +
  • Defined in src/pools/abstract-pool.ts:57
  • @@ -189,7 +189,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    @@ -210,7 +210,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:66
  • filePath: string
    @@ -218,7 +218,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • max?: number
    @@ -226,7 +226,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:91
  • numberOfWorkers: number
    @@ -234,7 +234,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:114
  • opts: PoolOptions<Worker>
    @@ -242,7 +242,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:116
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -255,7 +255,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:76
  • startTimestamp: number
    @@ -263,7 +263,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:104
  • started: boolean
    @@ -271,7 +271,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:100
  • starting: boolean
    @@ -279,7 +279,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:96
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -287,7 +287,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:82
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -296,7 +296,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:63
  • Accessors

    @@ -310,7 +310,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:691
  • +
  • Defined in src/pools/abstract-pool.ts:682
  • +
  • Defined in src/pools/abstract-pool.ts:354
  • +
  • Defined in src/pools/abstract-pool.ts:555
  • +
  • Defined in src/pools/abstract-pool.ts:548
  • +
  • Defined in src/pools/abstract-pool.ts:500
  • +
  • Defined in src/pools/abstract-pool.ts:538
  • +
  • Defined in src/pools/abstract-pool.ts:517
  • +
  • Defined in src/pools/abstract-pool.ts:543
  • Methods

    @@ -426,7 +426,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:1401
  • +
  • Defined in src/pools/abstract-pool.ts:879
  • +
  • Defined in src/pools/abstract-pool.ts:1151
  • +
  • Defined in src/pools/abstract-pool.ts:849
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:665
  • +
  • Defined in src/pools/abstract-pool.ts:1376
  • +
  • Defined in src/pools/abstract-pool.ts:1364
  • +
  • Defined in src/pools/abstract-pool.ts:1370
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:185
  • Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:167
  • Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:293
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:239
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:249
  • +
  • Defined in src/pools/abstract-pool.ts:1004
  • +
  • Defined in src/pools/abstract-pool.ts:1094
  • +
  • Defined in src/pools/abstract-pool.ts:1050
  • +
  • Defined in src/pools/abstract-pool.ts:1043
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1467
  • +
  • Defined in src/pools/abstract-pool.ts:794
  • +
  • Defined in src/pools/abstract-pool.ts:825
  • +
  • Defined in src/pools/abstract-pool.ts:636
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1461
  • +
  • Defined in src/pools/abstract-pool.ts:732
  • +
  • Defined in src/pools/abstract-pool.ts:1455
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1475
  • +
  • Defined in src/pools/abstract-pool.ts:1485
  • +
  • Defined in src/pools/abstract-pool.ts:1390
  • +
  • Defined in src/pools/abstract-pool.ts:584
  • +
  • Defined in src/pools/abstract-pool.ts:596
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1336
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1322
  • +
  • Defined in src/pools/abstract-pool.ts:1440
  • +
  • Defined in src/pools/abstract-pool.ts:1433
  • +
  • Defined in src/pools/abstract-pool.ts:698
  • +
  • Defined in src/pools/abstract-pool.ts:840
  • +
  • Defined in src/pools/abstract-pool.ts:719
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1191
  • +
  • Defined in src/pools/abstract-pool.ts:1138
  • +
  • Defined in src/pools/abstract-pool.ts:1424
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:804
  • +
  • Defined in src/pools/abstract-pool.ts:1171
  • +
  • Defined in src/pools/abstract-pool.ts:1178
  • +
  • Defined in src/pools/abstract-pool.ts:1032
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:659
  • +
  • Defined in src/pools/abstract-pool.ts:648
  • +
  • Defined in src/pools/abstract-pool.ts:603
  • +
  • Defined in src/pools/abstract-pool.ts:622
  • +
  • Defined in src/pools/abstract-pool.ts:833
  • +
  • Defined in src/pools/abstract-pool.ts:1021
  • +
  • Defined in src/pools/abstract-pool.ts:912
  • +
  • Defined in src/pools/abstract-pool.ts:341
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1229
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1471
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1264
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:965
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:939
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:921
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:951
  • +
  • Defined in src/pools/abstract-pool.ts:1302
  • +
  • Defined in src/worker/abstract-worker.ts:57
  • isMain: boolean
    @@ -180,7 +180,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:85
  • lastTaskTimestamp: number
    @@ -188,7 +188,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:65
  • mainWorker: MainWorker
    @@ -196,7 +196,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:86
  • opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
    @@ -204,7 +204,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:88
  • statistics: WorkerStatistics
    @@ -212,7 +212,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:69
  • 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:183
  • Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:568
  • +
  • Defined in src/worker/abstract-worker.ts:409
  • +
  • Defined in src/worker/abstract-worker.ts:375
  • +
  • Defined in src/worker/abstract-worker.ts:592
  • Returns void

    +
  • Defined in src/worker/abstract-worker.ts:298
  • +
  • Defined in src/worker/abstract-worker.ts:108
  • Returns void

    +
  • Defined in src/worker/abstract-worker.ts:98
  • Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:577
  • +
  • Defined in src/worker/abstract-worker.ts:423
  • +
  • Defined in src/worker/abstract-worker.ts:559
  • +
  • Defined in src/worker/abstract-worker.ts:455
  • +
  • Defined in src/worker/abstract-worker.ts:341
  • +
  • Defined in src/worker/abstract-worker.ts:312
  • +
  • Defined in src/worker/abstract-worker.ts:167
  • +
  • Defined in src/worker/abstract-worker.ts:245
  • +
  • Defined in src/worker/abstract-worker.ts:319
  • +
  • Defined in src/worker/abstract-worker.ts:221
  • +
  • Defined in src/worker/abstract-worker.ts:465
  • +
  • Defined in src/worker/abstract-worker.ts:517
  • +
  • Defined in src/worker/abstract-worker.ts:480
  • +
  • Defined in src/worker/abstract-worker.ts:442
  • +
  • Defined in src/worker/abstract-worker.ts:435
  • +
  • Defined in src/worker/abstract-worker.ts:275
  • +
  • Defined in src/worker/abstract-worker.ts:388
  • +
  • Defined in src/worker/abstract-worker.ts:399
  • +
  • Defined in src/worker/abstract-worker.ts:598
  • +
  • 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: number
    +
  • Defined in src/circular-array.ts:11
  • [species]: ArrayConstructor
    +
  • Defined in src/circular-array.ts:100
  • +
  • Defined in src/circular-array.ts:41
  • +
  • Defined in src/circular-array.ts:92
  • +
  • Defined in src/circular-array.ts:96
  • +
  • Defined in src/circular-array.ts:23
  • Returns void

    +
  • Defined in src/circular-array.ts:80
  • +
  • Defined in src/circular-array.ts:56
  • +
  • Defined in src/circular-array.ts:32
  • +
  • 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
  • isMain: boolean
    @@ -147,7 +147,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:85
  • lastTaskTimestamp: number
    @@ -156,7 +156,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:65
  • 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
  • statistics: WorkerStatistics
    @@ -174,7 +174,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:69
  • 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:183
  • +
  • Defined in src/worker/abstract-worker.ts:423
  • +
  • Defined in src/worker/abstract-worker.ts:455
  • +
  • Defined in src/worker/abstract-worker.ts:341
  • +
  • Defined in src/worker/cluster-worker.ts:45
  • +
  • Defined in src/worker/abstract-worker.ts:167
  • +
  • Defined in src/worker/abstract-worker.ts:245
  • +
  • Defined in src/worker/abstract-worker.ts:319
  • +
  • Defined in src/worker/abstract-worker.ts:221
  • +
  • Defined in src/worker/abstract-worker.ts:465
  • +
  • Defined in src/worker/abstract-worker.ts:517
  • +
  • Defined in src/worker/abstract-worker.ts:480
  • +
  • Defined in src/worker/abstract-worker.ts:442
  • +
  • Defined in src/worker/cluster-worker.ts:70
  • +
  • Defined in src/worker/abstract-worker.ts:275
  • @@ -77,14 +77,14 @@ Implemented with a doubly linked list.

    T

    Returns Deque<T>

    +
  • Defined in src/deque.ts:31
  • Properties

    head?: Node<T>
    +
  • Defined in src/deque.ts:24
  • maxSize: number
    @@ -92,7 +92,7 @@ Implemented with a doubly linked list.

    +
  • Defined in src/deque.ts:29
  • size: number
    @@ -100,12 +100,12 @@ Implemented with a doubly linked list.

    +
  • Defined in src/deque.ts:27
  • tail?: Node<T>
    +
  • Defined in src/deque.ts:25
  • 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:141
  • +
  • Defined in src/deque.ts:167
  • +
  • Defined in src/deque.ts:128
  • +
  • Defined in src/deque.ts:191
  • +
  • Defined in src/deque.ts:113
  • +
  • Defined in src/deque.ts:121
  • +
  • Defined in src/deque.ts:74
  • +
  • Defined in src/deque.ts:41
  • +
  • Defined in src/deque.ts:94
  • +
  • Defined in src/deque.ts:58
  • Type Parameters

      @@ -25,7 +25,7 @@
      • Node
    +
  • Defined in src/deque.ts:6
  • @@ -60,24 +60,24 @@
    value: T

    Returns Node<T>

    +
  • Defined in src/deque.ts:11
  • Properties

    next?: Node<T>
    +
  • Defined in src/deque.ts:8
  • prev?: Node<T>
    +
  • Defined in src/deque.ts:9
  • value: T
    +
  • Defined in src/deque.ts:7
  • +
  • Defined in src/worker/abstract-worker.ts:183
  • +
  • Defined in src/worker/abstract-worker.ts:423
  • +
  • Defined in src/worker/thread-worker.ts:96
  • +
  • Defined in src/worker/thread-worker.ts:79
  • +
  • Defined in src/worker/thread-worker.ts:54
    • @@ -392,7 +392,7 @@ never be called.

    +
  • Defined in src/worker/abstract-worker.ts:167
  • +
  • Defined in src/worker/abstract-worker.ts:245
  • +
  • Defined in src/worker/abstract-worker.ts:319
    • @@ -452,7 +452,7 @@ never be called.

    +
  • Defined in src/worker/abstract-worker.ts:221
  • +
  • Defined in src/worker/abstract-worker.ts:465
  • +
  • Defined in src/worker/abstract-worker.ts:517
  • +
  • Defined in src/worker/abstract-worker.ts:480
  • +
  • Defined in src/worker/abstract-worker.ts:442
  • +
  • Defined in src/worker/thread-worker.ts:91
  • +
  • Defined in src/worker/abstract-worker.ts:275
  • +
  • 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:40
  • opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
    @@ -126,12 +126,12 @@
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:52
  • 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
  • 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
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:119
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:132
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:200
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:213
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:145
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:159
  • +
  • Defined in src/pools/pool.ts:167
  • 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:16
  • errorHandler?: ErrorHandler<Worker>
    @@ -89,7 +89,7 @@
    +
  • Defined in src/pools/pool.ts:137
  • exitHandler?: ExitHandler<Worker>
    @@ -98,7 +98,7 @@
    +
  • Defined in src/pools/pool.ts:141
  • messageHandler?: MessageHandler<Worker>
    @@ -107,7 +107,7 @@
    +
  • Defined in src/pools/pool.ts:133
  • onlineHandler?: OnlineHandler<Worker>
    @@ -116,7 +116,7 @@
    +
  • Defined in src/pools/pool.ts:129
  • restartWorkerOnError?: boolean
    @@ -125,7 +125,7 @@
    +
  • Defined in src/pools/pool.ts:155
  • settings?: ClusterSettings
    @@ -135,7 +135,7 @@

    See

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

    +
  • Defined in src/pools/cluster/fixed.ts:22
  • tasksQueueOptions?: TasksQueueOptions
    @@ -144,7 +144,7 @@
    +
  • Defined in src/pools/pool.ts:171
  • 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:147
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/pool.ts:151
  • +
  • Defined in src/pools/pool.ts:217
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -130,7 +130,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:265
  • execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -165,7 +165,7 @@
    +
  • Defined in src/pools/pool.ts:226
  • hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    @@ -190,7 +190,7 @@
    +
  • Defined in src/pools/pool.ts:203
  • info: PoolInfo
    @@ -198,7 +198,7 @@
    +
  • Defined in src/pools/pool.ts:189
  • listTaskFunctions: (() => string[])
    @@ -215,7 +215,7 @@
    +
  • Defined in src/pools/pool.ts:240
  • setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -239,7 +239,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:274
  • setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -268,7 +268,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:247
  • setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -292,7 +292,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:256
  • workerNodes: IWorkerNode<Worker, Data>[]
    @@ -300,7 +300,7 @@
    +
  • Defined in src/pools/pool.ts:195
  • +
  • Defined in src/pools/worker.ts:185
  • once: ((event, handler) => void)
    @@ -147,12 +147,12 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:195
  • threadId?: number
    +
  • Defined in src/pools/worker.ts:178
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:202
  • 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
  • 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
  • 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
  • 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
  • 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
  • +
  • Defined in src/pools/worker.ts:288
  • dequeueTask: (() => undefined | Task<Data>)
    @@ -113,7 +113,7 @@
    +
  • Defined in src/pools/worker.ts:264
  • enqueueTask: ((task) => number)
    @@ -138,7 +138,7 @@
    +
  • Defined in src/pools/worker.ts:251
  • getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
    @@ -163,7 +163,7 @@
    +
  • Defined in src/pools/worker.ts:295
  • hasBackPressure: (() => boolean)
    @@ -180,7 +180,7 @@
    +
  • Defined in src/pools/worker.ts:280
  • info: WorkerInfo
    @@ -188,7 +188,7 @@
    +
  • Defined in src/pools/worker.ts:213
  • messageChannel?: MessageChannel
    @@ -196,7 +196,7 @@
    +
  • Defined in src/pools/worker.ts:217
  • onBackPressure?: ((workerId) => void)
    @@ -220,7 +220,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:232
  • onEmptyQueue?: ((workerId) => void)
    @@ -244,7 +244,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:238
  • popTask: (() => undefined | Task<Data>)
    @@ -261,7 +261,7 @@
    +
  • Defined in src/pools/worker.ts:270
  • resetUsage: (() => void)
    @@ -277,7 +277,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:284
  • tasksQueueBackPressureSize: number
    @@ -286,7 +286,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:226
  • tasksQueueSize: (() => number)
    @@ -303,7 +303,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:244
  • unshiftTask: ((task) => number)
    @@ -328,7 +328,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:258
  • usage: WorkerUsage
    @@ -336,7 +336,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:221
  • worker: Worker
    @@ -344,7 +344,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:209
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:63
  • +
  • Defined in src/pools/worker.ts:55
  • history: CircularArray<number>
    @@ -64,7 +64,7 @@
    +
  • Defined in src/pools/worker.ts:63
  • maximum?: number
    @@ -72,7 +72,7 @@
    +
  • Defined in src/pools/worker.ts:51
  • median?: number
    @@ -80,7 +80,7 @@
    +
  • Defined in src/pools/worker.ts:59
  • minimum?: number
    @@ -88,7 +88,7 @@
    +
  • Defined in src/pools/worker.ts:47
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:120
  • median: boolean
    @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:124
  • +
  • Defined in src/utility-types.ts:104
  • name?: string
    @@ -97,7 +97,7 @@
    +
  • Defined in src/utility-types.ts:73
  • port?: MessagePort
    @@ -105,7 +105,7 @@
    +
  • Defined in src/utility-types.ts:132
  • ready?: boolean
    @@ -113,7 +113,7 @@
    +
  • Defined in src/utility-types.ts:124
  • statistics?: WorkerStatistics
    @@ -121,7 +121,7 @@
    +
  • Defined in src/utility-types.ts:120
  • taskError?: TaskError<ErrorData>
    @@ -129,7 +129,7 @@
    +
  • Defined in src/utility-types.ts:108
  • taskFunctions?: string[]
    @@ -137,7 +137,7 @@
    +
  • Defined in src/utility-types.ts:116
  • taskId?: string
    @@ -146,7 +146,7 @@
    +
  • Defined in src/utility-types.ts:89
  • taskPerformance?: TaskPerformance
    @@ -154,7 +154,7 @@
    +
  • Defined in src/utility-types.ts:112
  • timestamp?: number
    @@ -163,7 +163,7 @@
    +
  • Defined in src/utility-types.ts:85
  • transferList?: TransferListItem[]
    @@ -172,7 +172,7 @@
    +
  • Defined in src/utility-types.ts:81
  • workerId: number
    @@ -181,7 +181,7 @@
    +
  • Defined in src/utility-types.ts:69
  • +
  • Defined in src/pools/pool.ts:75
  • maxQueuedTasks?: number
    +
  • Defined in src/pools/pool.ts:81
  • maxSize: number
    +
  • Defined in src/pools/pool.ts:69
  • minSize: number
    +
  • Defined in src/pools/pool.ts:68
  • queuedTasks?: number
    +
  • Defined in src/pools/pool.ts:80
  • ready: boolean
    +
  • Defined in src/pools/pool.ts:66
  • runTime?: {
        average: number;
        maximum: number;
        median?: number;
        minimum: number;
    }
    @@ -130,17 +130,17 @@
  • Readonly minimum: number
  • +
  • Defined in src/pools/pool.ts:84
  • strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    +
  • Defined in src/pools/pool.ts:67
  • type: "fixed" | "dynamic"
    +
  • Defined in src/pools/pool.ts:64
  • utilization?: number
    @@ -148,12 +148,12 @@
    +
  • Defined in src/pools/pool.ts:71
  • version: string
    +
  • Defined in src/pools/pool.ts:63
  • waitTime?: {
        average: number;
        maximum: number;
        median?: number;
        minimum: number;
    }
    @@ -169,12 +169,12 @@
  • Readonly minimum: number
  • +
  • Defined in src/pools/pool.ts:90
  • worker: "thread" | "cluster"
    +
  • Defined in src/pools/pool.ts:65
  • workerNodes: number
    @@ -182,7 +182,7 @@
    +
  • Defined in src/pools/pool.ts:73
  • +
  • Defined in src/pools/pool.ts:167
  • errorHandler?: ErrorHandler<Worker>
    @@ -83,7 +83,7 @@
    +
  • Defined in src/pools/pool.ts:137
  • exitHandler?: ExitHandler<Worker>
    @@ -91,7 +91,7 @@
    +
  • Defined in src/pools/pool.ts:141
  • messageHandler?: MessageHandler<Worker>
    @@ -99,7 +99,7 @@
    +
  • Defined in src/pools/pool.ts:133
  • onlineHandler?: OnlineHandler<Worker>
    @@ -107,7 +107,7 @@
    +
  • Defined in src/pools/pool.ts:129
  • restartWorkerOnError?: boolean
    @@ -115,7 +115,7 @@
    +
  • Defined in src/pools/pool.ts:155
  • tasksQueueOptions?: TasksQueueOptions
    @@ -123,7 +123,7 @@
    +
  • Defined in src/pools/pool.ts:171
  • 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:147
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -141,7 +141,7 @@
    +
  • Defined in src/pools/pool.ts:151
  • +
  • Defined in src/utility-types.ts:145
  • workerNodeKey: number
    @@ -95,7 +95,7 @@
    +
  • Defined in src/utility-types.ts:153
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:156
  • +
  • Defined in src/utility-types.ts:73
  • taskId?: string
    @@ -74,7 +74,7 @@
    +
  • Defined in src/utility-types.ts:89
  • timestamp?: number
    @@ -82,7 +82,7 @@
    +
  • Defined in src/utility-types.ts:85
  • transferList?: TransferListItem[]
    @@ -90,7 +90,7 @@
    +
  • Defined in src/utility-types.ts:81
  • workerId: number
    @@ -98,7 +98,7 @@
    +
  • Defined in src/utility-types.ts:69
  • +
  • Defined in src/utility-types.ts:18
  • name: string
    @@ -69,7 +69,7 @@
    +
  • Defined in src/utility-types.ts:14
  • +
  • Defined in src/utility-types.ts:34
  • runTime?: number
    @@ -62,7 +62,7 @@
    +
  • Defined in src/utility-types.ts:42
  • timestamp: number
    @@ -70,7 +70,7 @@
    +
  • Defined in src/utility-types.ts:38
  • +
  • Defined in src/pools/worker.ts:90
  • failed: number
    @@ -63,7 +63,7 @@
    +
  • Defined in src/pools/worker.ts:102
  • maxQueued?: number
    @@ -71,7 +71,7 @@
    +
  • Defined in src/pools/worker.ts:98
  • queued: number
    @@ -79,7 +79,7 @@
    +
  • Defined in src/pools/worker.ts:94
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:136
  • @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:140
  • +
  • Defined in src/pools/pool.ts:111
  • size?: number
    @@ -65,7 +65,7 @@

    Default Value

    (pool maximum size)^2

    +
  • Defined in src/pools/pool.ts:107
  • +
  • Defined in src/pools/pool.ts:167
  • errorHandler?: ErrorHandler<Worker>
    @@ -78,7 +78,7 @@
    +
  • Defined in src/pools/pool.ts:137
  • exitHandler?: ExitHandler<Worker>
    @@ -87,7 +87,7 @@
    +
  • Defined in src/pools/pool.ts:141
  • messageHandler?: MessageHandler<Worker>
    @@ -96,7 +96,7 @@
    +
  • Defined in src/pools/pool.ts:133
  • onlineHandler?: OnlineHandler<Worker>
    @@ -105,7 +105,7 @@
    +
  • Defined in src/pools/pool.ts:129
  • restartWorkerOnError?: boolean
    @@ -114,7 +114,7 @@
    +
  • Defined in src/pools/pool.ts:155
  • tasksQueueOptions?: TasksQueueOptions
    @@ -123,7 +123,7 @@
    +
  • Defined in src/pools/pool.ts:171
  • 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:147
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -143,7 +143,7 @@
    +
  • Defined in src/pools/pool.ts:151
  • workerOptions?: WorkerOptions
    @@ -153,7 +153,7 @@

    See

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

    +
  • Defined in src/pools/thread/fixed.ts:24
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:97
  • measurement?: "runTime" | "waitTime" | "elu"
    @@ -68,7 +68,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:79
  • runTime?: MeasurementOptions
    @@ -78,7 +78,7 @@

    Default Value

    { median: false }

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

    Default Value

    { median: false }

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:91
  • weights?: Record<number, number>
    @@ -99,7 +99,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:104
  • +
  • Defined in src/pools/worker.ts:127
  • ready: boolean
    @@ -63,7 +63,7 @@
    +
  • Defined in src/pools/worker.ts:139
  • taskFunctions?: string[]
    @@ -71,7 +71,7 @@
    +
  • Defined in src/pools/worker.ts:143
  • type: "thread" | "cluster"
    @@ -79,7 +79,7 @@
    +
  • Defined in src/pools/worker.ts:131
  • +
  • Defined in src/worker/worker-options.ts:39
  • killHandler?: KillHandler
    @@ -73,7 +73,7 @@
    +
  • Defined in src/worker/worker-options.ts:56
  • maxInactiveTime?: number
    @@ -90,7 +90,7 @@ when this timeout expires your tasks is interrupted before completion and remove

    Default Value

    60000

    +
  • Defined in src/worker/worker-options.ts:52
  • +
  • Defined in src/pools/worker.ts:159
  • @@ -62,7 +62,7 @@
    +
  • Defined in src/pools/worker.ts:155
  • @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:163
  • +
  • Defined in src/pools/worker.ts:21
  • +
  • Defined in src/pools/worker.ts:29
  • +
  • Defined in src/worker/worker-options.ts:18
  • +
  • Defined in src/worker/worker-options.ts:23
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:54
  • +
  • Defined in src/pools/worker.ts:13
  • +
  • Defined in src/pools/worker.ts:8
  • +
  • Defined in src/pools/pool.ts:57
  • +
  • Defined in src/pools/pool.ts:34
  • +
  • Defined in src/worker/task-functions.ts:18
  • +
  • Defined in src/worker/task-functions.ts:7
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:40
  • +
  • Defined in src/pools/worker.ts:116
  • +
  • Defined in src/worker/worker-options.ts:4
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:45
  • +
  • Defined in src/pools/pool.ts:44
  • +
  • Defined in src/pools/pool.ts:20
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
  • +
  • Defined in src/pools/worker.ts:108