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
  • filePath: string
    @@ -224,7 +224,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:116
  • max?: number
    @@ -232,7 +232,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:92
  • numberOfWorkers: number
    @@ -240,7 +240,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • opts: PoolOptions<Worker>
    @@ -248,7 +248,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:117
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -261,7 +261,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:77
  • startTimestamp: number
    @@ -269,7 +269,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:105
  • started: boolean
    @@ -277,7 +277,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:97
  • starting: boolean
    @@ -285,7 +285,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:101
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -293,7 +293,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:83
  • 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
  • +
  • Defined in src/pools/abstract-pool.ts:722
  • +
  • Defined in src/pools/abstract-pool.ts:342
  • +
  • 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

    @@ -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
  • +
  • Defined in src/pools/abstract-pool.ts:935
  • +
  • Defined in src/pools/abstract-pool.ts:1209
  • +
  • Defined in src/pools/abstract-pool.ts:905
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:671
  • +
  • Defined in src/pools/abstract-pool.ts:1444
  • +
  • Defined in src/pools/abstract-pool.ts:1432
  • +
  • Defined in src/pools/abstract-pool.ts:1438
  • Returns void

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

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:257
  • +
  • Defined in src/pools/abstract-pool.ts:1062
  • +
  • Defined in src/pools/abstract-pool.ts:1152
  • +
  • Defined in src/pools/abstract-pool.ts:1108
  • +
  • Defined in src/pools/abstract-pool.ts:1101
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1534
  • +
  • Defined in src/pools/abstract-pool.ts:850
  • +
  • Defined in src/pools/abstract-pool.ts:881
  • +
  • Defined in src/pools/abstract-pool.ts:636
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1528
  • +
  • Defined in src/pools/abstract-pool.ts:779
  • +
  • Defined in src/pools/abstract-pool.ts:1522
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1542
  • +
  • Defined in src/pools/abstract-pool.ts:1552
  • +
  • Defined in src/pools/abstract-pool.ts:1458
  • +
  • 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:1404
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1390
  • +
  • Defined in src/pools/abstract-pool.ts:1507
  • +
  • Defined in src/pools/abstract-pool.ts:1500
  • +
  • Defined in src/pools/abstract-pool.ts:738
  • +
  • Defined in src/pools/abstract-pool.ts:896
  • +
  • Defined in src/pools/abstract-pool.ts:758
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1253
  • +
  • Defined in src/pools/abstract-pool.ts:1196
  • +
  • Defined in src/pools/abstract-pool.ts:1491
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:860
  • +
  • Defined in src/pools/abstract-pool.ts:1233
  • +
  • Defined in src/pools/abstract-pool.ts:1240
  • +
  • Defined in src/pools/abstract-pool.ts:1090
  • +
  • Defined in src/pools/abstract-pool.ts:691
  • +
  • Defined in src/pools/abstract-pool.ts:650
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:685
  • +
  • Defined in src/pools/abstract-pool.ts:704
  • +
  • Defined in src/pools/abstract-pool.ts:603
  • +
  • Defined in src/pools/abstract-pool.ts:622
  • +
  • Defined in src/pools/abstract-pool.ts:889
  • +
  • Defined in src/pools/abstract-pool.ts:1079
  • Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:770
  • +
  • Defined in src/pools/abstract-pool.ts:968
  • +
  • Defined in src/pools/abstract-pool.ts:834
  • Returns void

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

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

    +
  • Defined in src/pools/abstract-pool.ts:1329
  • +
  • Defined in src/pools/abstract-pool.ts:698
  • +
  • Defined in src/pools/abstract-pool.ts:711
  • Returns void

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:1009
  • +
  • Defined in src/pools/abstract-pool.ts:1372
  • +
  • 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:220
  • Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:601
  • +
  • Defined in src/worker/abstract-worker.ts:446
  • +
  • Defined in src/worker/abstract-worker.ts:412
  • +
  • Defined in src/worker/abstract-worker.ts:625
  • Returns void

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

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

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

    +
  • Defined in src/worker/abstract-worker.ts:610
  • +
  • Defined in src/worker/abstract-worker.ts:461
  • +
  • Defined in src/worker/abstract-worker.ts:493
  • +
  • Defined in src/worker/abstract-worker.ts:378
  • +
  • Defined in src/worker/abstract-worker.ts:349
  • +
  • Defined in src/worker/abstract-worker.ts:204
  • +
  • Defined in src/worker/abstract-worker.ts:282
  • +
  • Defined in src/worker/abstract-worker.ts:356
  • +
  • Defined in src/worker/abstract-worker.ts:258
  • +
  • Defined in src/worker/abstract-worker.ts:503
  • +
  • Defined in src/worker/abstract-worker.ts:567
  • +
  • Defined in src/worker/abstract-worker.ts:531
  • +
  • Defined in src/worker/abstract-worker.ts:480
  • +
  • Defined in src/worker/abstract-worker.ts:473
  • +
  • Defined in src/worker/abstract-worker.ts:312
  • +
  • Defined in src/worker/abstract-worker.ts:425
  • +
  • Defined in src/worker/abstract-worker.ts:436
  • +
  • Defined in src/worker/abstract-worker.ts:631
  • +
  • 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:220
  • +
  • Defined in src/worker/abstract-worker.ts:461
  • +
  • Defined in src/worker/abstract-worker.ts:493
  • +
  • Defined in src/worker/abstract-worker.ts:378
  • +
  • Defined in src/worker/cluster-worker.ts:45
  • +
  • Defined in src/worker/abstract-worker.ts:204
  • +
  • Defined in src/worker/abstract-worker.ts:282
  • +
  • Defined in src/worker/abstract-worker.ts:356
  • +
  • Defined in src/worker/abstract-worker.ts:258
  • +
  • Defined in src/worker/abstract-worker.ts:503
  • +
  • Defined in src/worker/abstract-worker.ts:567
  • +
  • Defined in src/worker/abstract-worker.ts:531
  • +
  • Defined in src/worker/abstract-worker.ts:480
  • +
  • Defined in src/worker/cluster-worker.ts:70
  • +
  • Defined in src/worker/abstract-worker.ts:312
  • +
  • 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

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

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

    +
  • Defined in src/deque.ts:30
  • 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
  • +
  • Defined in src/deque.ts:170
  • +
  • Defined in src/deque.ts:131
  • +
  • Defined in src/deque.ts:194
  • +
  • Defined in src/deque.ts:116
  • +
  • Defined in src/deque.ts:124
  • +
  • Defined in src/deque.ts:77
  • +
  • Defined in src/deque.ts:44
  • +
  • Defined in src/deque.ts:97
  • +
  • Defined in src/deque.ts:61
  • +
  • Defined in src/deque.ts:12
  • +
  • Defined in src/worker/abstract-worker.ts:220
    • @@ -310,7 +310,7 @@ never be called.

    +
  • Defined in src/worker/abstract-worker.ts:461
  • +
  • Defined in src/worker/thread-worker.ts:96
  • +
  • Defined in src/worker/thread-worker.ts:79
  • +
  • Defined in src/worker/thread-worker.ts:54
    • @@ -394,7 +394,7 @@ never be called.

    +
  • Defined in src/worker/abstract-worker.ts:204
  • +
  • Defined in src/worker/abstract-worker.ts:282
  • +
  • Defined in src/worker/abstract-worker.ts:356
    • @@ -454,7 +454,7 @@ never be called.

    +
  • Defined in src/worker/abstract-worker.ts:258
    • @@ -476,7 +476,7 @@ never be called.

    +
  • Defined in src/worker/abstract-worker.ts:503
  • +
  • Defined in src/worker/abstract-worker.ts:567
  • +
  • Defined in src/worker/abstract-worker.ts:531
  • +
  • Defined in src/worker/abstract-worker.ts:480
  • +
  • Defined in src/worker/thread-worker.ts:91
    • @@ -640,7 +640,7 @@ then restore the original execution context.

    +
  • Defined in src/worker/abstract-worker.ts:312
  • +
  • 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
  • retriesCount: number = 0
    @@ -126,12 +126,12 @@
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:40
  • 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:191
  • 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
  • errorHandler?: ErrorHandler<Worker>
    @@ -94,7 +94,7 @@
    +
  • Defined in src/pools/pool.ts:153
  • exitHandler?: ExitHandler<Worker>
    @@ -105,7 +105,7 @@
    +
  • Defined in src/pools/pool.ts:159
  • messageHandler?: MessageHandler<Worker>
    @@ -116,7 +116,7 @@
    +
  • Defined in src/pools/pool.ts:147
  • onlineHandler?: OnlineHandler<Worker>
    @@ -127,7 +127,7 @@
    +
  • Defined in src/pools/pool.ts:141
  • restartWorkerOnError?: boolean
    @@ -136,7 +136,7 @@
    +
  • Defined in src/pools/pool.ts:179
  • settings?: ClusterSettings
    @@ -146,7 +146,7 @@

    See

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

    +
  • Defined in src/pools/cluster/fixed.ts:22
  • startWorkers?: boolean
    @@ -158,7 +158,7 @@
    +
  • Defined in src/pools/pool.ts:165
  • tasksQueueOptions?: TasksQueueOptions
    @@ -167,7 +167,7 @@
    +
  • Defined in src/pools/pool.ts:195
  • 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
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -188,7 +188,7 @@
    +
  • Defined in src/pools/pool.ts:175
  • +
  • Defined in src/pools/pool.ts:241
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -131,7 +131,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:293
  • execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -166,7 +166,7 @@
    +
  • Defined in src/pools/pool.ts:250
  • hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    @@ -191,7 +191,7 @@
    +
  • Defined in src/pools/pool.ts:227
  • info: PoolInfo
    @@ -199,7 +199,7 @@
    +
  • Defined in src/pools/pool.ts:213
  • listTaskFunctions: (() => string[])
    @@ -216,7 +216,7 @@
    +
  • Defined in src/pools/pool.ts:268
  • setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -240,7 +240,7 @@

    Returns void

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

    Returns void

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

    Returns void

    +
  • Defined in src/pools/pool.ts:284
  • start: (() => void)
    @@ -309,7 +309,7 @@

    Returns void

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

    Returns void

    +
  • Defined in src/pools/worker.ts:208
  • threadId?: number
    +
  • Defined in src/pools/worker.ts:191
  • +
  • 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:310
  • dequeueTask: (() => undefined | Task<Data>)
    @@ -114,7 +114,7 @@
    +
  • Defined in src/pools/worker.ts:286
  • enqueueTask: ((task) => number)
    @@ -139,7 +139,7 @@
    +
  • Defined in src/pools/worker.ts:273
  • getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/worker.ts:317
  • hasBackPressure: (() => boolean)
    @@ -181,7 +181,7 @@
    +
  • Defined in src/pools/worker.ts:302
  • @@ -189,7 +189,7 @@
    +
  • Defined in src/pools/worker.ts:234
  • messageChannel?: MessageChannel
    @@ -197,7 +197,7 @@
    +
  • Defined in src/pools/worker.ts:247
  • onBackPressure?: WorkerNodeEventCallback
    @@ -205,7 +205,7 @@
    +
  • Defined in src/pools/worker.ts:256
  • @@ -213,7 +213,7 @@
    +
  • Defined in src/pools/worker.ts:260
  • popTask: (() => undefined | Task<Data>)
    @@ -230,7 +230,7 @@
    +
  • Defined in src/pools/worker.ts:292
  • resetUsage: (() => void)
    @@ -246,7 +246,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:306
  • 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: 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
  • 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
  • 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
  • @@ -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
  • 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
  • +
  • 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:110
  • name?: string
    @@ -97,7 +97,7 @@
    +
  • Defined in src/utility-types.ts:79
  • port?: MessagePort
    @@ -105,7 +105,7 @@
    +
  • Defined in src/utility-types.ts:138
  • ready?: boolean
    @@ -113,7 +113,7 @@
    +
  • Defined in src/utility-types.ts:130
  • statistics?: WorkerStatistics
    @@ -121,7 +121,7 @@
    +
  • Defined in src/utility-types.ts:126
  • taskError?: TaskError<ErrorData>
    @@ -129,7 +129,7 @@
    +
  • Defined in src/utility-types.ts:114
  • taskFunctions?: string[]
    @@ -137,7 +137,7 @@
    +
  • Defined in src/utility-types.ts:122
  • taskId?: string
    @@ -146,7 +146,7 @@
    +
  • Defined in src/utility-types.ts:95
  • taskPerformance?: TaskPerformance
    @@ -154,7 +154,7 @@
    +
  • Defined in src/utility-types.ts:118
  • timestamp?: number
    @@ -163,7 +163,7 @@
    +
  • Defined in src/utility-types.ts:91
  • transferList?: TransferListItem[]
    @@ -172,7 +172,7 @@
    +
  • Defined in src/utility-types.ts:87
  • workerId: number
    @@ -181,7 +181,7 @@
    +
  • Defined in src/utility-types.ts:75
  • +
  • Defined in src/pools/pool.ts:76
  • maxQueuedTasks?: number
    +
  • Defined in src/pools/pool.ts:82
  • maxSize: number
    +
  • Defined in src/pools/pool.ts:70
  • minSize: number
    +
  • Defined in src/pools/pool.ts:69
  • queuedTasks?: number
    +
  • Defined in src/pools/pool.ts:81
  • ready: boolean
    +
  • Defined in src/pools/pool.ts:67
  • runTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }
    @@ -132,27 +132,27 @@
  • Readonly minimum: number
  • +
  • Defined in src/pools/pool.ts:86
  • started: boolean
    +
  • Defined in src/pools/pool.ts:66
  • stolenTasks?: 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:68
  • type: "fixed" | "dynamic"
    +
  • Defined in src/pools/pool.ts:64
  • utilization?: number
    @@ -160,12 +160,12 @@
    +
  • Defined in src/pools/pool.ts:72
  • version: string
    +
  • Defined in src/pools/pool.ts:63
  • waitTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }
    @@ -181,12 +181,12 @@
  • Readonly minimum: number
  • +
  • Defined in src/pools/pool.ts:92
  • worker: "thread" | "cluster"
    +
  • Defined in src/pools/pool.ts:65
  • workerNodes: number
    @@ -194,7 +194,7 @@
    +
  • Defined in src/pools/pool.ts:74
  • +
  • Defined in src/pools/pool.ts:191
  • errorHandler?: ErrorHandler<Worker>
    @@ -88,7 +88,7 @@

    Default Value

    () => {}

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

    Default Value

    () => {}

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

    Default Value

    () => {}

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

    Default Value

    () => {}

    +
  • Defined in src/pools/pool.ts:141
  • restartWorkerOnError?: boolean
    @@ -126,7 +126,7 @@
    +
  • Defined in src/pools/pool.ts:179
  • startWorkers?: boolean
    @@ -137,7 +137,7 @@
    +
  • Defined in src/pools/pool.ts:165
  • tasksQueueOptions?: TasksQueueOptions
    @@ -145,7 +145,7 @@
    +
  • Defined in src/pools/pool.ts:195
  • 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
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/pool.ts:175
  • +
  • Defined in src/utility-types.ts:151
  • workerNodeKey: number
    @@ -95,7 +95,7 @@
    +
  • Defined in src/utility-types.ts:159
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:156
  • +
  • Defined in src/utility-types.ts:79
  • taskId?: string
    @@ -74,7 +74,7 @@
    +
  • Defined in src/utility-types.ts:95
  • timestamp?: number
    @@ -82,7 +82,7 @@
    +
  • Defined in src/utility-types.ts:91
  • transferList?: TransferListItem[]
    @@ -90,7 +90,7 @@
    +
  • Defined in src/utility-types.ts:87
  • workerId: number
    @@ -98,7 +98,7 @@
    +
  • Defined in src/utility-types.ts:75
  • +
  • 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
    @@ -64,7 +64,7 @@
    +
  • Defined in src/pools/worker.ts:106
  • maxQueued?: number
    @@ -72,7 +72,7 @@
    +
  • Defined in src/pools/worker.ts:98
  • queued: number
    @@ -80,7 +80,7 @@
    +
  • Defined in src/pools/worker.ts:94
  • stolen: number
    @@ -88,7 +88,7 @@
    +
  • Defined in src/pools/worker.ts:102
  • +
  • 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:109
  • taskStealing?: boolean
    @@ -71,7 +71,7 @@
    +
  • Defined in src/pools/pool.ts:121
  • tasksStealingOnBackPressure?: boolean
    @@ -82,7 +82,7 @@
    +
  • Defined in src/pools/pool.ts:127
  • +
  • Defined in src/pools/pool.ts:191
  • errorHandler?: ErrorHandler<Worker>
    @@ -83,7 +83,7 @@
    +
  • Defined in src/pools/pool.ts:153
  • exitHandler?: ExitHandler<Worker>
    @@ -94,7 +94,7 @@
    +
  • Defined in src/pools/pool.ts:159
  • messageHandler?: MessageHandler<Worker>
    @@ -105,7 +105,7 @@
    +
  • Defined in src/pools/pool.ts:147
  • onlineHandler?: OnlineHandler<Worker>
    @@ -116,7 +116,7 @@
    +
  • Defined in src/pools/pool.ts:141
  • restartWorkerOnError?: boolean
    @@ -125,7 +125,7 @@
    +
  • Defined in src/pools/pool.ts:179
  • startWorkers?: boolean
    @@ -137,7 +137,7 @@
    +
  • Defined in src/pools/pool.ts:165
  • tasksQueueOptions?: TasksQueueOptions
    @@ -146,7 +146,7 @@
    +
  • Defined in src/pools/pool.ts:195
  • 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
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -167,7 +167,7 @@
    +
  • Defined in src/pools/pool.ts:175
  • 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
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:79
  • retries?: number
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:75
  • @@ -81,7 +81,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:85
  • @@ -92,7 +92,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:91
  • 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
  • +
  • Defined in src/pools/worker.ts:131
  • ready: boolean
    @@ -63,7 +63,7 @@
    +
  • Defined in src/pools/worker.ts:143
  • taskFunctions?: string[]
    @@ -71,7 +71,7 @@
    +
  • Defined in src/pools/worker.ts:147
  • type: "thread" | "cluster"
    @@ -79,7 +79,7 @@
    +
  • Defined in src/pools/worker.ts:135
  • +
  • Defined in src/worker/worker-options.ts:39
  • killHandler?: KillHandler
    @@ -77,7 +77,7 @@

    Default Value

    () => {}

    +
  • Defined in src/worker/worker-options.ts:58
  • 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
  • +
  • Defined in src/utility-types.ts:58
  • +
  • Defined in src/pools/worker.ts:163
  • @@ -62,7 +62,7 @@
    +
  • Defined in src/pools/worker.ts:159
  • @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:167
  • +
  • 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:217
  • +
  • Defined in src/pools/worker.ts:120
  • +
  • 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:112