From adab53c70d781f8c26e35b7359efa3d05c278fa8 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 30 Aug 2023 21:03:41 +0000 Subject: [PATCH] chore: generate documentation --- docs/classes/AbstractPool.html | 178 +++++++++--------- docs/classes/AbstractWorker.html | 80 ++++---- docs/classes/CircularArray.html | 28 +-- docs/classes/ClusterWorker.html | 54 +++--- docs/classes/Deque.html | 38 ++-- docs/classes/DynamicClusterPool.html | 96 +++++----- docs/classes/DynamicThreadPool.html | 96 +++++----- docs/classes/FixedClusterPool.html | 96 +++++----- docs/classes/FixedThreadPool.html | 96 +++++----- docs/classes/Node.html | 16 +- docs/classes/PoolEmitter.html | 8 +- docs/classes/ThreadWorker.html | 56 +++--- docs/classes/WorkerChoiceStrategyContext.html | 32 ++-- docs/functions/availableParallelism.html | 8 +- docs/index.html | 8 +- docs/interfaces/ClusterPoolOptions.html | 32 ++-- ...tLoopUtilizationMeasurementStatistics.html | 14 +- docs/interfaces/IPool.html | 30 +-- docs/interfaces/IWorker.html | 16 +- docs/interfaces/IWorkerChoiceStrategy.html | 22 +-- docs/interfaces/IWorkerNode.html | 42 ++--- docs/interfaces/MeasurementOptions.html | 10 +- docs/interfaces/MeasurementStatistics.html | 20 +- .../MeasurementStatisticsRequirements.html | 14 +- docs/interfaces/MessageValue.html | 36 ++-- docs/interfaces/PoolInfo.html | 48 ++--- docs/interfaces/PoolOptions.html | 28 +-- docs/interfaces/PromiseResponseWrapper.html | 14 +- docs/interfaces/StrategyPolicy.html | 12 +- docs/interfaces/Task.html | 20 +- docs/interfaces/TaskError.html | 14 +- docs/interfaces/TaskPerformance.html | 16 +- docs/interfaces/TaskStatistics.html | 20 +- .../TaskStatisticsRequirements.html | 14 +- docs/interfaces/TasksQueueOptions.html | 14 +- docs/interfaces/ThreadPoolOptions.html | 30 +-- .../WorkerChoiceStrategyOptions.html | 20 +- docs/interfaces/WorkerInfo.html | 18 +- docs/interfaces/WorkerOptions.html | 16 +- docs/interfaces/WorkerStatistics.html | 12 +- docs/interfaces/WorkerUsage.html | 16 +- docs/types/ErrorHandler.html | 8 +- docs/types/ExitHandler.html | 8 +- docs/types/KillBehavior.html | 8 +- docs/types/KillHandler.html | 8 +- docs/types/Measurement.html | 8 +- docs/types/MessageHandler.html | 8 +- docs/types/OnlineHandler.html | 8 +- docs/types/PoolEvent.html | 8 +- docs/types/PoolType.html | 8 +- docs/types/TaskAsyncFunction.html | 8 +- docs/types/TaskFunction.html | 8 +- docs/types/TaskFunctions.html | 8 +- docs/types/TaskSyncFunction.html | 8 +- docs/types/WorkerChoiceStrategy.html | 8 +- docs/types/WorkerNodeEventCallback.html | 8 +- docs/types/WorkerType.html | 8 +- docs/types/Writable.html | 8 +- docs/variables/KillBehaviors.html | 8 +- docs/variables/Measurements.html | 8 +- docs/variables/PoolEvents.html | 8 +- docs/variables/PoolTypes.html | 8 +- docs/variables/WorkerChoiceStrategies.html | 8 +- docs/variables/WorkerTypes.html | 8 +- 64 files changed, 811 insertions(+), 811 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index e81c6e15..95e8ad65 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.38
+AbstractPool | poolifier - v2.6.39
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.38
+
  • The search index is not available
  • poolifier - v2.6.39
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:57
  • @@ -188,7 +188,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    @@ -209,7 +209,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:66
  • filePath: string
    @@ -217,7 +217,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • max?: number
    @@ -225,7 +225,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:91
  • numberOfWorkers: number
    @@ -233,7 +233,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:114
  • opts: PoolOptions<Worker>
    @@ -241,7 +241,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:116
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -254,7 +254,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:76
  • startTimestamp: number
    @@ -262,7 +262,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:104
  • started: boolean
    @@ -270,7 +270,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:100
  • starting: boolean
    @@ -278,7 +278,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:96
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -286,7 +286,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:82
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -295,7 +295,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:63
  • Accessors

    @@ -309,7 +309,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:696
  • +
  • Defined in src/pools/abstract-pool.ts:687
  • +
  • Defined in src/pools/abstract-pool.ts:348
  • +
  • Defined in src/pools/abstract-pool.ts:560
  • +
  • Defined in src/pools/abstract-pool.ts:553
  • +
  • Defined in src/pools/abstract-pool.ts:505
  • +
  • Defined in src/pools/abstract-pool.ts:543
  • +
  • Defined in src/pools/abstract-pool.ts:522
  • +
  • Defined in src/pools/abstract-pool.ts:548
  • Methods

    @@ -424,7 +424,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:1427
  • +
  • Defined in src/pools/abstract-pool.ts:886
  • +
  • Defined in src/pools/abstract-pool.ts:1160
  • +
  • Defined in src/pools/abstract-pool.ts:856
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:670
  • +
  • Defined in src/pools/abstract-pool.ts:1402
  • +
  • Defined in src/pools/abstract-pool.ts:1390
  • +
  • Defined in src/pools/abstract-pool.ts:1396
  • 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:570
  • 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:1013
  • +
  • Defined in src/pools/abstract-pool.ts:1103
  • +
  • Defined in src/pools/abstract-pool.ts:1059
  • +
  • Defined in src/pools/abstract-pool.ts:1052
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1492
  • +
  • Defined in src/pools/abstract-pool.ts:801
  • +
  • Defined in src/pools/abstract-pool.ts:832
  • +
  • Defined in src/pools/abstract-pool.ts:641
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1486
  • +
  • Defined in src/pools/abstract-pool.ts:745
  • +
  • Defined in src/pools/abstract-pool.ts:1480
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1500
  • +
  • Defined in src/pools/abstract-pool.ts:1510
  • +
  • Defined in src/pools/abstract-pool.ts:1416
  • +
  • Defined in src/pools/abstract-pool.ts:589
  • +
  • Defined in src/pools/abstract-pool.ts:601
  • Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1348
  • +
  • Defined in src/pools/abstract-pool.ts:1465
  • +
  • Defined in src/pools/abstract-pool.ts:1458
  • +
  • Defined in src/pools/abstract-pool.ts:703
  • +
  • Defined in src/pools/abstract-pool.ts:847
  • +
  • Defined in src/pools/abstract-pool.ts:724
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1200
  • +
  • Defined in src/pools/abstract-pool.ts:1147
  • +
  • Defined in src/pools/abstract-pool.ts:1449
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:811
  • +
  • Defined in src/pools/abstract-pool.ts:1180
  • +
  • Defined in src/pools/abstract-pool.ts:1187
  • +
  • Defined in src/pools/abstract-pool.ts:1041
  • +
  • Defined in src/pools/abstract-pool.ts:653
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:664
  • +
  • Defined in src/pools/abstract-pool.ts:608
  • +
  • Defined in src/pools/abstract-pool.ts:627
  • +
  • Defined in src/pools/abstract-pool.ts:840
  • +
  • Defined in src/pools/abstract-pool.ts:1030
  • Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:736
  • +
  • Defined in src/pools/abstract-pool.ts:919
  • +
  • Defined in src/pools/abstract-pool.ts:335
  • Returns void

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

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

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:960
  • +
  • Defined in src/pools/abstract-pool.ts:1328
  • @@ -47,7 +47,7 @@
  • ClusterWorker
  • ThreadWorker
  • +
  • Defined in src/worker/abstract-worker.ts:49
  • @@ -149,7 +149,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:83
  • Properties

    @@ -159,7 +159,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:73
  • id: number
    @@ -167,7 +167,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:57
  • isMain: boolean
    @@ -175,7 +175,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:85
  • lastTaskTimestamp: number
    @@ -183,7 +183,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:65
  • mainWorker: MainWorker
    @@ -191,7 +191,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:86
  • opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
    @@ -199,7 +199,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:88
  • statistics: WorkerStatistics
    @@ -207,7 +207,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:69
  • taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -215,7 +215,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:61
  • Methods

    @@ -247,7 +247,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:193
  • Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:576
  • +
  • Defined in src/worker/abstract-worker.ts:419
  • +
  • Defined in src/worker/abstract-worker.ts:385
  • +
  • Defined in src/worker/abstract-worker.ts:600
  • Returns void

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

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

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

    +
  • Defined in src/worker/abstract-worker.ts:585
  • +
  • Defined in src/worker/abstract-worker.ts:434
  • +
  • Defined in src/worker/abstract-worker.ts:466
  • +
  • Defined in src/worker/abstract-worker.ts:351
  • +
  • Defined in src/worker/abstract-worker.ts:322
  • +
  • Defined in src/worker/abstract-worker.ts:177
  • +
  • Defined in src/worker/abstract-worker.ts:255
  • +
  • Defined in src/worker/abstract-worker.ts:329
  • +
  • Defined in src/worker/abstract-worker.ts:231
  • +
  • Defined in src/worker/abstract-worker.ts:476
  • +
  • Defined in src/worker/abstract-worker.ts:541
  • +
  • Defined in src/worker/abstract-worker.ts:504
  • +
  • Defined in src/worker/abstract-worker.ts:453
  • +
  • Defined in src/worker/abstract-worker.ts:446
  • +
  • Defined in src/worker/abstract-worker.ts:285
  • +
  • Defined in src/worker/abstract-worker.ts:398
  • +
  • Defined in src/worker/abstract-worker.ts:409
  • +
  • Defined in src/worker/abstract-worker.ts:606
  • @@ -31,7 +31,7 @@
    • CircularArray
    +
  • 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
  • @@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.

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

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

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

    +
  • Defined in src/worker/abstract-worker.ts:73
  • isMain: boolean
    @@ -145,7 +145,7 @@ but the minimum number of workers will be guaranteed.

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

    +
  • Defined in src/worker/abstract-worker.ts:65
  • opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
    @@ -163,7 +163,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:88
  • statistics: WorkerStatistics
    @@ -172,7 +172,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:69
  • taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -181,7 +181,7 @@ but the minimum number of workers will be guaranteed.

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

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

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

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

    +
  • Defined in src/worker/abstract-worker.ts:193
  • +
  • Defined in src/worker/abstract-worker.ts:434
  • +
  • Defined in src/worker/abstract-worker.ts:466
  • +
  • Defined in src/worker/abstract-worker.ts:351
  • +
  • Defined in src/worker/cluster-worker.ts:45
  • +
  • Defined in src/worker/abstract-worker.ts:177
  • +
  • Defined in src/worker/abstract-worker.ts:255
  • +
  • Defined in src/worker/abstract-worker.ts:329
  • +
  • Defined in src/worker/abstract-worker.ts:231
  • +
  • Defined in src/worker/abstract-worker.ts:476
  • +
  • Defined in src/worker/abstract-worker.ts:541
  • +
  • Defined in src/worker/abstract-worker.ts:504
  • +
  • Defined in src/worker/abstract-worker.ts:453
  • +
  • Defined in src/worker/cluster-worker.ts:70
  • +
  • Defined in src/worker/abstract-worker.ts:285
  • @@ -33,7 +33,7 @@ Implemented with a doubly linked list.

    • Deque
    +
  • 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
  • @@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is +
  • Defined in src/pools/cluster/dynamic.ts:15
  • @@ -146,7 +146,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

    @@ -167,7 +167,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:66
  • filePath: string
    @@ -176,7 +176,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:115
  • max: number
    @@ -185,7 +185,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:29
  • numberOfWorkers: number
    @@ -194,7 +194,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:114
  • @@ -203,7 +203,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/fixed.ts:47
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -217,7 +217,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:76
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -226,7 +226,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:82
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -235,7 +235,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:63
  • Accessors

    @@ -250,7 +250,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:43
    • @@ -263,7 +263,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:687
    • @@ -275,7 +275,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:348
    • @@ -287,7 +287,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:560
    • @@ -299,7 +299,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:553
    • @@ -311,7 +311,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:505
    • @@ -324,7 +324,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:38
    • @@ -337,7 +337,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:522
    • @@ -349,7 +349,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

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

    +
  • Defined in src/pools/abstract-pool.ts:886
  • +
  • Defined in src/pools/abstract-pool.ts:1160
  • +
  • Defined in src/pools/abstract-pool.ts:856
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/abstract-pool.ts:1103
  • +
  • Defined in src/pools/abstract-pool.ts:1059
  • +
  • Defined in src/pools/cluster/fixed.ts:109
  • +
  • Defined in src/pools/abstract-pool.ts:801
  • +
  • Defined in src/pools/cluster/fixed.ts:63
  • +
  • Defined in src/pools/abstract-pool.ts:641
  • +
  • Defined in src/pools/abstract-pool.ts:745
  • +
  • Defined in src/pools/abstract-pool.ts:1500
  • +
  • Defined in src/pools/abstract-pool.ts:1416
  • +
  • Defined in src/pools/abstract-pool.ts:1458
  • +
  • Defined in src/pools/abstract-pool.ts:703
  • +
  • Defined in src/pools/cluster/fixed.ts:58
  • +
  • Defined in src/pools/abstract-pool.ts:724
  • +
  • Defined in src/pools/cluster/fixed.ts:101
  • +
  • Defined in src/pools/abstract-pool.ts:811
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/cluster/fixed.ts:85
  • +
  • Defined in src/pools/abstract-pool.ts:653
  • +
  • Defined in src/pools/abstract-pool.ts:608
  • +
  • Defined in src/pools/abstract-pool.ts:627
  • +
  • Defined in src/pools/cluster/fixed.ts:53
  • +
  • Defined in src/pools/abstract-pool.ts:1328
  • @@ -45,7 +45,7 @@ When the maximum number of threads is reached and workers are busy, an event is +
  • Defined in src/pools/thread/dynamic.ts:15
  • @@ -146,7 +146,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

    @@ -167,7 +167,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:66
  • filePath: string
    @@ -176,7 +176,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:115
  • max: number
    @@ -185,7 +185,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:29
  • numberOfWorkers: number
    @@ -194,7 +194,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:114
  • @@ -203,7 +203,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/fixed.ts:49
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -217,7 +217,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:76
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -226,7 +226,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:82
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -235,7 +235,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:63
  • Accessors

    @@ -250,7 +250,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:43
    • @@ -263,7 +263,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:687
    • @@ -275,7 +275,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:348
    • @@ -287,7 +287,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:560
    • @@ -299,7 +299,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:553
    • @@ -311,7 +311,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:505
    • @@ -324,7 +324,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:38
    • @@ -337,7 +337,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:522
    • @@ -349,7 +349,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

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

    +
  • Defined in src/pools/abstract-pool.ts:886
  • +
  • Defined in src/pools/abstract-pool.ts:1160
  • +
  • Defined in src/pools/abstract-pool.ts:856
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/abstract-pool.ts:1103
  • +
  • Defined in src/pools/abstract-pool.ts:1059
  • +
  • Defined in src/pools/thread/fixed.ts:117
  • +
  • Defined in src/pools/abstract-pool.ts:801
  • +
  • Defined in src/pools/thread/fixed.ts:60
  • +
  • Defined in src/pools/abstract-pool.ts:641
  • +
  • Defined in src/pools/abstract-pool.ts:745
  • +
  • Defined in src/pools/abstract-pool.ts:1500
  • +
  • Defined in src/pools/abstract-pool.ts:1416
  • +
  • Defined in src/pools/abstract-pool.ts:1458
  • +
  • Defined in src/pools/abstract-pool.ts:703
  • +
  • Defined in src/pools/thread/fixed.ts:55
  • +
  • Defined in src/pools/abstract-pool.ts:724
  • +
  • Defined in src/pools/thread/fixed.ts:107
  • +
  • Defined in src/pools/abstract-pool.ts:811
  • +
  • Defined in src/pools/thread/fixed.ts:91
  • +
  • Defined in src/pools/thread/fixed.ts:80
  • +
  • Defined in src/pools/abstract-pool.ts:653
  • +
  • Defined in src/pools/abstract-pool.ts:608
  • +
  • Defined in src/pools/abstract-pool.ts:627
  • +
  • Defined in src/pools/abstract-pool.ts:840
  • +
  • Defined in src/pools/abstract-pool.ts:1328
  • @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
  • @@ -142,7 +142,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44
  • Properties

    @@ -163,7 +163,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:66
  • filePath: string
    @@ -172,7 +172,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • max?: number
    @@ -181,7 +181,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:91
  • numberOfWorkers: number
    @@ -190,7 +190,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:114
  • @@ -199,7 +199,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:47
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -213,7 +213,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:76
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -222,7 +222,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:82
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -231,7 +231,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:63
  • Accessors

    @@ -246,7 +246,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:124
  • +
  • Defined in src/pools/abstract-pool.ts:687
  • +
  • Defined in src/pools/abstract-pool.ts:348
  • +
  • Defined in src/pools/abstract-pool.ts:560
  • +
  • Defined in src/pools/abstract-pool.ts:553
  • +
  • Defined in src/pools/abstract-pool.ts:505
  • +
  • Defined in src/pools/cluster/fixed.ts:114
  • +
  • Defined in src/pools/abstract-pool.ts:522
  • +
  • Defined in src/pools/cluster/fixed.ts:119
  • Methods

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

    +
  • Defined in src/pools/abstract-pool.ts:886
  • +
  • Defined in src/pools/abstract-pool.ts:1160
  • +
  • Defined in src/pools/abstract-pool.ts:856
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/abstract-pool.ts:1103
  • +
  • Defined in src/pools/abstract-pool.ts:1059
  • +
  • Defined in src/pools/cluster/fixed.ts:109
  • +
  • Defined in src/pools/abstract-pool.ts:801
  • +
  • Defined in src/pools/cluster/fixed.ts:63
  • +
  • Defined in src/pools/abstract-pool.ts:641
  • +
  • Defined in src/pools/abstract-pool.ts:745
  • +
  • Defined in src/pools/abstract-pool.ts:1500
  • +
  • Defined in src/pools/abstract-pool.ts:1416
  • +
  • Defined in src/pools/abstract-pool.ts:1458
  • +
  • Defined in src/pools/abstract-pool.ts:703
  • +
  • Defined in src/pools/cluster/fixed.ts:58
  • +
  • Defined in src/pools/abstract-pool.ts:724
  • +
  • Defined in src/pools/cluster/fixed.ts:101
  • +
  • Defined in src/pools/abstract-pool.ts:811
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/cluster/fixed.ts:85
  • +
  • Defined in src/pools/abstract-pool.ts:653
  • +
  • Defined in src/pools/abstract-pool.ts:608
  • +
  • Defined in src/pools/abstract-pool.ts:627
  • +
  • Defined in src/pools/cluster/fixed.ts:53
  • +
  • Defined in src/pools/abstract-pool.ts:1328
  • @@ -45,7 +45,7 @@ +
  • Defined in src/pools/thread/fixed.ts:35
  • @@ -142,7 +142,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:46
  • Properties

    @@ -163,7 +163,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:66
  • filePath: string
    @@ -172,7 +172,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • max?: number
    @@ -181,7 +181,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:91
  • numberOfWorkers: number
    @@ -190,7 +190,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:114
  • @@ -199,7 +199,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:49
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -213,7 +213,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:76
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -222,7 +222,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:82
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -231,7 +231,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:63
  • Accessors

    @@ -246,7 +246,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:135
  • +
  • Defined in src/pools/abstract-pool.ts:687
  • +
  • Defined in src/pools/abstract-pool.ts:348
  • +
  • Defined in src/pools/abstract-pool.ts:560
  • +
  • Defined in src/pools/abstract-pool.ts:553
  • +
  • Defined in src/pools/abstract-pool.ts:505
  • +
  • Defined in src/pools/thread/fixed.ts:125
  • +
  • Defined in src/pools/abstract-pool.ts:522
  • +
  • Defined in src/pools/thread/fixed.ts:130
  • Methods

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

    +
  • Defined in src/pools/abstract-pool.ts:886
  • +
  • Defined in src/pools/abstract-pool.ts:1160
  • +
  • Defined in src/pools/abstract-pool.ts:856
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/abstract-pool.ts:1103
  • +
  • Defined in src/pools/abstract-pool.ts:1059
  • +
  • Defined in src/pools/thread/fixed.ts:117
  • +
  • Defined in src/pools/abstract-pool.ts:801
  • +
  • Defined in src/pools/thread/fixed.ts:60
  • +
  • Defined in src/pools/abstract-pool.ts:641
  • +
  • Defined in src/pools/abstract-pool.ts:745
  • +
  • Defined in src/pools/abstract-pool.ts:1500
  • +
  • Defined in src/pools/abstract-pool.ts:1416
  • +
  • Defined in src/pools/abstract-pool.ts:1458
  • +
  • Defined in src/pools/abstract-pool.ts:703
  • +
  • Defined in src/pools/thread/fixed.ts:55
  • +
  • Defined in src/pools/abstract-pool.ts:724
  • +
  • Defined in src/pools/thread/fixed.ts:107
  • +
  • Defined in src/pools/abstract-pool.ts:811
  • +
  • Defined in src/pools/thread/fixed.ts:91
  • +
  • Defined in src/pools/thread/fixed.ts:80
  • +
  • Defined in src/pools/abstract-pool.ts:653
  • +
  • Defined in src/pools/abstract-pool.ts:608
  • +
  • Defined in src/pools/abstract-pool.ts:627
  • +
  • Defined in src/pools/abstract-pool.ts:840
  • +
  • Defined in src/pools/abstract-pool.ts:1328
  • @@ -32,7 +32,7 @@ +
  • Defined in src/deque.ts:9
  • @@ -67,24 +67,24 @@
    data: T

    Returns Node<T>

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

    data: T
    +
  • Defined in src/deque.ts:10
  • next?: Node<T>
    +
  • Defined in src/deque.ts:11
  • prev?: Node<T>
    +
  • Defined in src/deque.ts:12
  • @@ -26,7 +26,7 @@ +
  • Defined in src/pools/pool.ts:39
  • @@ -903,7 +903,7 @@ special handling:

  • once
  • setMaxListeners
  • @@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/thread-worker.ts:26
  • @@ -126,7 +126,7 @@ but the minimum number of workers will be guaranteed.

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

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

    +
  • Defined in src/worker/abstract-worker.ts:73
  • isMain: boolean
    @@ -146,7 +146,7 @@ but the minimum number of workers will be guaranteed.

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

    +
  • Defined in src/worker/abstract-worker.ts:65
  • opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
    @@ -164,7 +164,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:88
  • port: MessagePort
    @@ -172,7 +172,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/thread-worker.ts:33
  • statistics: WorkerStatistics
    @@ -181,7 +181,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:69
  • taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -190,7 +190,7 @@ but the minimum number of workers will be guaranteed.

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

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

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

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

    +
  • Defined in src/worker/abstract-worker.ts:193
  • +
  • Defined in src/worker/abstract-worker.ts:434
  • +
  • Defined in src/worker/thread-worker.ts:96
  • +
  • Defined in src/worker/thread-worker.ts:79
  • +
  • Defined in src/worker/thread-worker.ts:54
  • +
  • Defined in src/worker/abstract-worker.ts:177
  • +
  • Defined in src/worker/abstract-worker.ts:255
  • +
  • Defined in src/worker/abstract-worker.ts:329
  • +
  • Defined in src/worker/abstract-worker.ts:231
  • +
  • Defined in src/worker/abstract-worker.ts:476
  • +
  • Defined in src/worker/abstract-worker.ts:541
  • +
  • Defined in src/worker/abstract-worker.ts:504
  • +
  • Defined in src/worker/abstract-worker.ts:453
  • +
  • Defined in src/worker/thread-worker.ts:91
  • +
  • Defined in src/worker/abstract-worker.ts:285
  • @@ -42,7 +42,7 @@
    • WorkerChoiceStrategyContext
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:27
  • @@ -105,7 +105,7 @@

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

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

    @@ -115,7 +115,7 @@
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:52
  • retriesCount: number = 0
    @@ -123,12 +123,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
    @@ -136,7 +136,7 @@
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:51
  • Methods

    @@ -152,7 +152,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
  • @@ -26,7 +26,7 @@ Always returns a value greater than zero.

    +
  • Defined in src/utils.ts:57
  • -

    poolifier - v2.6.38

    +

    poolifier - v2.6.39

    Index

    @@ -109,7 +109,7 @@

    Theme

    @@ -26,7 +26,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:10
  • @@ -60,7 +60,7 @@
    +
  • Defined in src/pools/pool.ts:162
  • enableTasksQueue?: boolean
    @@ -72,7 +72,7 @@
    +
  • Defined in src/pools/pool.ts:168
  • env?: Record<string, unknown>
    @@ -82,7 +82,7 @@

    See

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

    +
  • Defined in src/pools/cluster/fixed.ts:16
  • errorHandler?: ErrorHandler<Worker>
    @@ -91,7 +91,7 @@
    +
  • Defined in src/pools/pool.ts:138
  • exitHandler?: ExitHandler<Worker>
    @@ -100,7 +100,7 @@
    +
  • Defined in src/pools/pool.ts:142
  • messageHandler?: MessageHandler<Worker>
    @@ -109,7 +109,7 @@
    +
  • Defined in src/pools/pool.ts:134
  • onlineHandler?: OnlineHandler<Worker>
    @@ -118,7 +118,7 @@
    +
  • Defined in src/pools/pool.ts:130
  • restartWorkerOnError?: boolean
    @@ -127,7 +127,7 @@
    +
  • Defined in src/pools/pool.ts:156
  • settings?: ClusterSettings
    @@ -137,7 +137,7 @@

    See

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

    +
  • Defined in src/pools/cluster/fixed.ts:22
  • tasksQueueOptions?: TasksQueueOptions
    @@ -146,7 +146,7 @@
    +
  • Defined in src/pools/pool.ts:172
  • 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:148
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -167,7 +167,7 @@
    +
  • Defined in src/pools/pool.ts:152
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/worker.ts:71
  • @@ -42,17 +42,17 @@
    +
  • Defined in src/pools/worker.ts:73
  • +
  • Defined in src/pools/worker.ts:72
  • utilization?: number
    +
  • Defined in src/pools/worker.ts:74
  • @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:182
  • @@ -83,7 +83,7 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:235
  • emitter?: PoolEmitter
    @@ -101,7 +101,7 @@
    +
  • Defined in src/pools/pool.ts:218
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -128,7 +128,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:266
  • execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -160,7 +160,7 @@
    +
  • Defined in src/pools/pool.ts:227
  • hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    @@ -184,7 +184,7 @@
    +
  • Defined in src/pools/pool.ts:204
  • info: PoolInfo
    @@ -192,7 +192,7 @@
    +
  • Defined in src/pools/pool.ts:190
  • listTaskFunctions: (() => string[])
    @@ -209,7 +209,7 @@
    +
  • Defined in src/pools/pool.ts:241
  • setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -232,7 +232,7 @@

    Returns void

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

    Returns void

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

    Returns void

    +
  • Defined in src/pools/pool.ts:257
  • workerNodes: IWorkerNode<Worker, Data>[]
    @@ -290,7 +290,7 @@
    +
  • Defined in src/pools/pool.ts:196
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/worker.ts:177
  • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:181
  • 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:189
  • once: ((event, handler) => void)
    @@ -145,12 +145,12 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:199
  • threadId?: number
    +
  • Defined in src/pools/worker.ts:182
  • @@ -24,7 +24,7 @@ +
  • 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
  • remove: ((workerNodeKey) => boolean)
    @@ -83,7 +83,7 @@ If the worker node is not eligible, undefined is returned.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:202
  • reset: (() => boolean)
    @@ -100,7 +100,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)
    @@ -123,7 +123,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
    @@ -131,7 +131,7 @@ If the worker node is not eligible, undefined is returned.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:172
  • taskStatisticsRequirements: TaskStatisticsRequirements
    @@ -139,7 +139,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)
    @@ -161,7 +161,7 @@ If the worker node is not eligible, undefined is returned.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:188
  • @@ -37,7 +37,7 @@ +
  • Defined in src/pools/worker.ts:217
  • @@ -80,7 +80,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:282
  • closeChannel: (() => void)
    @@ -96,7 +96,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:296
  • dequeueTask: (() => undefined | Task<Data>)
    @@ -113,7 +113,7 @@
    +
  • Defined in src/pools/worker.ts:272
  • enqueueTask: ((task) => number)
    @@ -137,7 +137,7 @@
    +
  • Defined in src/pools/worker.ts:259
  • getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
    @@ -161,7 +161,7 @@
    +
  • Defined in src/pools/worker.ts:303
  • hasBackPressure: (() => boolean)
    @@ -178,7 +178,7 @@
    +
  • Defined in src/pools/worker.ts:288
  • info: WorkerInfo
    @@ -186,7 +186,7 @@
    +
  • Defined in src/pools/worker.ts:225
  • messageChannel?: MessageChannel
    @@ -194,7 +194,7 @@
    +
  • Defined in src/pools/worker.ts:233
  • onBackPressure?: WorkerNodeEventCallback
    @@ -202,7 +202,7 @@
    +
  • Defined in src/pools/worker.ts:242
  • onEmptyQueue?: WorkerNodeEventCallback
    @@ -210,7 +210,7 @@
    +
  • Defined in src/pools/worker.ts:246
  • popTask: (() => undefined | Task<Data>)
    @@ -227,7 +227,7 @@
    +
  • Defined in src/pools/worker.ts:278
  • resetUsage: (() => void)
    @@ -243,7 +243,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:292
  • tasksQueueBackPressureSize: number
    @@ -252,7 +252,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:238
  • tasksQueueSize: (() => number)
    @@ -269,7 +269,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:252
  • unshiftTask: ((task) => number)
    @@ -293,7 +293,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:266
  • usage: WorkerUsage
    @@ -301,7 +301,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:229
  • worker: Worker
    @@ -309,7 +309,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:221
  • @@ -24,7 +24,7 @@ +
  • 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
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/worker.ts:39
  • @@ -48,7 +48,7 @@
    +
  • Defined in src/pools/worker.ts:43
  • average?: number
    @@ -56,7 +56,7 @@
    +
  • 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
  • @@ -24,7 +24,7 @@ +
  • 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: boolean
    @@ -53,7 +53,7 @@
    +
  • 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
  • @@ -39,7 +39,7 @@ +
  • Defined in src/utility-types.ts:105
  • @@ -71,7 +71,7 @@
    +
  • Defined in src/utility-types.ts:134
  • data?: Data
    @@ -80,7 +80,7 @@
    +
  • Defined in src/utility-types.ts:83
  • kill?: true | "success" | "SOFT" | "HARD" | "failure"
    @@ -88,7 +88,7 @@
    +
  • 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
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/pool.ts:62
  • @@ -59,7 +59,7 @@
    backPressure?: boolean
    +
  • Defined in src/pools/pool.ts:82
  • busyWorkerNodes: number
    @@ -67,22 +67,22 @@
    +
  • Defined in src/pools/pool.ts:77
  • executedTasks: number
    +
  • Defined in src/pools/pool.ts:78
  • executingTasks: number
    +
  • Defined in src/pools/pool.ts:79
  • failedTasks: number
    +
  • Defined in src/pools/pool.ts:84
  • idleWorkerNodes: number
    @@ -90,32 +90,32 @@
    +
  • 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;
    }
    @@ -131,22 +131,22 @@
  • Readonly minimum: number
  • +
  • Defined in src/pools/pool.ts:85
  • stolenTasks?: number
    +
  • Defined in src/pools/pool.ts:83
  • 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
    @@ -154,12 +154,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;
    }
    @@ -175,12 +175,12 @@
  • Readonly minimum: number
  • +
  • Defined in src/pools/pool.ts:91
  • worker: "thread" | "cluster"
    +
  • Defined in src/pools/pool.ts:65
  • workerNodes: number
    @@ -188,7 +188,7 @@
    +
  • Defined in src/pools/pool.ts:73
  • @@ -35,7 +35,7 @@
  • ClusterPoolOptions
  • ThreadPoolOptions
  • +
  • Defined in src/pools/pool.ts:126
  • @@ -66,7 +66,7 @@
    +
  • Defined in src/pools/pool.ts:162
  • enableTasksQueue?: boolean
    @@ -77,7 +77,7 @@
    +
  • Defined in src/pools/pool.ts:168
  • errorHandler?: ErrorHandler<Worker>
    @@ -85,7 +85,7 @@
    +
  • Defined in src/pools/pool.ts:138
  • exitHandler?: ExitHandler<Worker>
    @@ -93,7 +93,7 @@
    +
  • Defined in src/pools/pool.ts:142
  • messageHandler?: MessageHandler<Worker>
    @@ -101,7 +101,7 @@
    +
  • Defined in src/pools/pool.ts:134
  • onlineHandler?: OnlineHandler<Worker>
    @@ -109,7 +109,7 @@
    +
  • Defined in src/pools/pool.ts:130
  • restartWorkerOnError?: boolean
    @@ -117,7 +117,7 @@
    +
  • Defined in src/pools/pool.ts:156
  • tasksQueueOptions?: TasksQueueOptions
    @@ -125,7 +125,7 @@
    +
  • Defined in src/pools/pool.ts:172
  • workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    @@ -136,7 +136,7 @@
    +
  • Defined in src/pools/pool.ts:148
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -144,7 +144,7 @@
    +
  • Defined in src/pools/pool.ts:152
  • @@ -32,7 +32,7 @@ +
  • Defined in src/utility-types.ts:147
  • @@ -66,7 +66,7 @@

    Returns void

    +
  • Defined in src/utility-types.ts:155
  • resolve: ((value) => void)
    @@ -87,7 +87,7 @@

    Returns void

    +
  • Defined in src/utility-types.ts:151
  • workerNodeKey: number
    @@ -95,7 +95,7 @@
    +
  • Defined in src/utility-types.ts:159
  • @@ -24,7 +24,7 @@ +
  • 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
  • dynamicWorkerUsage: boolean
    @@ -52,7 +52,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:156
  • @@ -34,7 +34,7 @@ +
  • Defined in src/utility-types.ts:71
  • @@ -58,7 +58,7 @@
    +
  • Defined in src/utility-types.ts:83
  • name?: string
    @@ -66,7 +66,7 @@
    +
  • 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
  • @@ -32,7 +32,7 @@ +
  • Defined in src/utility-types.ts:10
  • @@ -53,7 +53,7 @@
    +
  • Defined in src/utility-types.ts:22
  • message: string
    @@ -61,7 +61,7 @@
    +
  • Defined in src/utility-types.ts:18
  • name: string
    @@ -69,7 +69,7 @@
    +
  • Defined in src/utility-types.ts:14
  • @@ -24,7 +24,7 @@ +
  • Defined in src/utility-types.ts:30
  • @@ -46,7 +46,7 @@
    +
  • Defined in src/utility-types.ts:46
  • name: string
    @@ -54,7 +54,7 @@
    +
  • 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
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/worker.ts:82
  • @@ -48,7 +48,7 @@
    +
  • Defined in src/pools/worker.ts:86
  • executing: number
    @@ -56,7 +56,7 @@
    +
  • 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
  • @@ -24,7 +24,7 @@ +
  • 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
  • @@ -53,7 +53,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:136
  • waitTime: MeasurementStatisticsRequirements
    @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:140
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/pool.ts:102
  • @@ -48,7 +48,7 @@
    +
  • Defined in src/pools/pool.ts:118
  • queueMaxSize?: number
    @@ -56,7 +56,7 @@

    Deprecated

    Use size instead.

    +
  • Defined in src/pools/pool.ts:112
  • size?: number
    @@ -67,7 +67,7 @@
    +
  • Defined in src/pools/pool.ts:108
  • @@ -26,7 +26,7 @@ +
  • Defined in src/pools/thread/fixed.ts:18
  • @@ -59,7 +59,7 @@
    +
  • Defined in src/pools/pool.ts:162
  • enableTasksQueue?: boolean
    @@ -71,7 +71,7 @@
    +
  • Defined in src/pools/pool.ts:168
  • errorHandler?: ErrorHandler<Worker>
    @@ -80,7 +80,7 @@
    +
  • Defined in src/pools/pool.ts:138
  • exitHandler?: ExitHandler<Worker>
    @@ -89,7 +89,7 @@
    +
  • Defined in src/pools/pool.ts:142
  • messageHandler?: MessageHandler<Worker>
    @@ -98,7 +98,7 @@
    +
  • Defined in src/pools/pool.ts:134
  • onlineHandler?: OnlineHandler<Worker>
    @@ -107,7 +107,7 @@
    +
  • Defined in src/pools/pool.ts:130
  • restartWorkerOnError?: boolean
    @@ -116,7 +116,7 @@
    +
  • Defined in src/pools/pool.ts:156
  • tasksQueueOptions?: TasksQueueOptions
    @@ -125,7 +125,7 @@
    +
  • Defined in src/pools/pool.ts:172
  • workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    @@ -137,7 +137,7 @@
    +
  • Defined in src/pools/pool.ts:148
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -146,7 +146,7 @@
    +
  • Defined in src/pools/pool.ts:152
  • workerOptions?: WorkerOptions
    @@ -156,7 +156,7 @@

    See

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

    +
  • Defined in src/pools/thread/fixed.ts:24
  • @@ -24,7 +24,7 @@ +
  • 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
  • measurement?: "runTime" | "waitTime" | "elu"
    @@ -59,7 +59,7 @@
    +
  • 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
  • runTime?: MeasurementOptions
    @@ -81,7 +81,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:85
  • waitTime?: MeasurementOptions
    @@ -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
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/worker.ts:127
  • @@ -47,7 +47,7 @@
    +
  • Defined in src/pools/worker.ts:139
  • id: undefined | number
    @@ -55,7 +55,7 @@
    +
  • 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
  • @@ -24,7 +24,7 @@ +
  • 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:63
  • killBehavior?: "SOFT" | "HARD"
    @@ -67,7 +67,7 @@
    +
  • Defined in src/worker/worker-options.ts:39
  • killHandler?: KillHandler
    @@ -75,7 +75,7 @@
    +
  • Defined in src/worker/worker-options.ts:56
  • maxInactiveTime?: number
    @@ -93,7 +93,7 @@ when this timeout expires your tasks is interrupted before completion and remove
    +
  • Defined in src/worker/worker-options.ts:52
  • @@ -24,7 +24,7 @@ +
  • Defined in src/utility-types.ts:54
  • @@ -44,7 +44,7 @@
    +
  • Defined in src/utility-types.ts:62
  • runTime: boolean
    @@ -52,7 +52,7 @@
    +
  • Defined in src/utility-types.ts:58
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/worker.ts:155
  • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:171
  • @@ -54,7 +54,7 @@
    +
  • Defined in src/pools/worker.ts:163
  • tasks: TaskStatistics
    @@ -62,7 +62,7 @@
    +
  • Defined in src/pools/worker.ts:159
  • waitTime: MeasurementStatistics
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:167
  • @@ -40,7 +40,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:21
  • @@ -40,7 +40,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:29
  • @@ -20,7 +20,7 @@
    +
  • Defined in src/worker/worker-options.ts:18
  • @@ -28,7 +28,7 @@

    Returns void | Promise<void>

    +
  • Defined in src/worker/worker-options.ts:23
  • @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:54
  • @@ -40,7 +40,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:13
  • @@ -38,7 +38,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:8
  • @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/pool.ts:57
  • @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/pool.ts:34
  • @@ -47,7 +47,7 @@ This function must return a promise.

    Returns Promise<Response>

    +
  • Defined in src/worker/task-functions.ts:18
  • @@ -34,7 +34,7 @@ This function can be synchronous or asynchronous.

    +
  • Defined in src/worker/task-functions.ts:29
  • @@ -36,7 +36,7 @@ The value is the function itself.

    +
  • Defined in src/worker/task-functions.ts:42
  • @@ -46,7 +46,7 @@

    Returns Response

    +
  • Defined in src/worker/task-functions.ts:7
  • @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:40
  • @@ -35,7 +35,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:208
  • @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/worker.ts:120
  • @@ -22,7 +22,7 @@
  • T

  • +
  • Defined in src/utility-types.ts:162
  • @@ -33,7 +33,7 @@
    +
  • Defined in src/worker/worker-options.ts:4
  • @@ -29,7 +29,7 @@
    Readonly waitTime: "waitTime"
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:45
  • @@ -37,7 +37,7 @@
    Readonly taskError: "taskError"
    +
  • Defined in src/pools/pool.ts:44
  • @@ -33,7 +33,7 @@
    +
  • Defined in src/pools/pool.ts:20
  • @@ -58,7 +58,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
  • @@ -27,7 +27,7 @@
    Readonly thread: "thread"
    +
  • Defined in src/pools/worker.ts:112