From 85003dff831b309b12d624215a8d67634af82b50 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 9 Jul 2023 22:52:35 +0000 Subject: [PATCH] chore: generate documentation --- docs/classes/AbstractPool.html | 146 +++++++++--------- docs/classes/AbstractWorker.html | 68 ++++---- docs/classes/CircularArray.html | 28 ++-- docs/classes/ClusterWorker.html | 50 +++--- docs/classes/DynamicClusterPool.html | 84 +++++----- docs/classes/DynamicThreadPool.html | 84 +++++----- docs/classes/FixedClusterPool.html | 82 +++++----- docs/classes/FixedThreadPool.html | 82 +++++----- docs/classes/PoolEmitter.html | 8 +- docs/classes/Queue.html | 28 ++-- docs/classes/ThreadWorker.html | 50 +++--- docs/classes/WorkerChoiceStrategyContext.html | 28 ++-- docs/functions/availableParallelism.html | 8 +- docs/index.html | 8 +- docs/interfaces/ClusterPoolOptions.html | 32 ++-- ...tLoopUtilizationMeasurementStatistics.html | 14 +- docs/interfaces/IPool.html | 26 ++-- docs/interfaces/IWorker.html | 16 +- docs/interfaces/IWorkerChoiceStrategy.html | 22 +-- docs/interfaces/IWorkerNode.html | 26 ++-- docs/interfaces/MeasurementOptions.html | 10 +- docs/interfaces/MeasurementStatistics.html | 20 +-- .../MeasurementStatisticsRequirements.html | 14 +- docs/interfaces/MessageValue.html | 30 ++-- docs/interfaces/PoolInfo.html | 44 +++--- docs/interfaces/PoolOptions.html | 28 ++-- docs/interfaces/PromiseResponseWrapper.html | 14 +- docs/interfaces/StrategyPolicy.html | 10 +- docs/interfaces/Task.html | 18 +-- docs/interfaces/TaskError.html | 14 +- docs/interfaces/TaskPerformance.html | 16 +- docs/interfaces/TaskStatistics.html | 18 +-- .../TaskStatisticsRequirements.html | 14 +- docs/interfaces/TasksQueueOptions.html | 10 +- docs/interfaces/ThreadPoolOptions.html | 30 ++-- .../WorkerChoiceStrategyOptions.html | 18 +-- docs/interfaces/WorkerInfo.html | 16 +- docs/interfaces/WorkerOptions.html | 14 +- 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/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/TaskFunctions.html | 8 +- docs/types/WorkerAsyncFunction.html | 8 +- docs/types/WorkerChoiceStrategy.html | 8 +- docs/types/WorkerFunction.html | 8 +- docs/types/WorkerSyncFunction.html | 8 +- docs/types/WorkerType.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 +- 60 files changed, 708 insertions(+), 708 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index fc48e1e3..69eed59d 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.13
+AbstractPool | poolifier - v2.6.14
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.13
+
  • The search index is not available
  • poolifier - v2.6.14
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:53
  • @@ -175,7 +175,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    @@ -194,7 +194,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62
  • filePath: string
    @@ -202,7 +202,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:100
  • numberOfWorkers: number
    @@ -210,7 +210,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:99
  • opts: PoolOptions<Worker>
    @@ -218,7 +218,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:101
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -231,7 +231,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:72
  • startTimestamp: number
    @@ -239,7 +239,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:89
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -247,7 +247,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:80
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -256,7 +256,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:59
  • Accessors

    @@ -270,7 +270,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:575
  • +
  • Defined in src/pools/abstract-pool.ts:566
  • +
  • Defined in src/pools/abstract-pool.ts:272
  • +
  • Defined in src/pools/abstract-pool.ts:464
  • +
  • Defined in src/pools/abstract-pool.ts:459
  • +
  • Defined in src/pools/abstract-pool.ts:416
  • +
  • Defined in src/pools/abstract-pool.ts:408
  • +
  • Defined in src/pools/abstract-pool.ts:449
  • +
  • Defined in src/pools/abstract-pool.ts:428
  • +
  • Defined in src/pools/abstract-pool.ts:454
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:692
  • +
  • Defined in src/pools/abstract-pool.ts:927
  • +
  • Defined in src/pools/abstract-pool.ts:671
  • Returns TasksQueueOptions

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

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

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

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:219
  • +
  • Defined in src/pools/abstract-pool.ts:869
  • +
  • Defined in src/pools/abstract-pool.ts:1010
  • +
  • Defined in src/pools/abstract-pool.ts:944
  • +
  • Defined in src/pools/abstract-pool.ts:919
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1142
  • +
  • Defined in src/pools/abstract-pool.ts:626
  • +
  • Defined in src/pools/abstract-pool.ts:647
  • +
  • Defined in src/pools/abstract-pool.ts:531
  • Returns number

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

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

    +
  • Defined in src/pools/abstract-pool.ts:1150
  • +
  • Defined in src/pools/abstract-pool.ts:1160
  • +
  • Defined in src/pools/abstract-pool.ts:472
  • +
  • Defined in src/pools/abstract-pool.ts:1106
  • +
  • Defined in src/pools/abstract-pool.ts:494
  • Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1054
  • +
  • Defined in src/pools/abstract-pool.ts:582
  • +
  • Defined in src/pools/abstract-pool.ts:662
  • +
  • Defined in src/pools/abstract-pool.ts:1116
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:977
  • +
  • Defined in src/pools/abstract-pool.ts:907
  • +
  • Defined in src/pools/abstract-pool.ts:1125
  • +
  • Defined in src/pools/abstract-pool.ts:896
  • +
  • Defined in src/pools/abstract-pool.ts:543
  • +
  • Defined in src/pools/abstract-pool.ts:501
  • +
  • Defined in src/pools/abstract-pool.ts:520
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1166
  • +
  • Defined in src/pools/abstract-pool.ts:655
  • +
  • Defined in src/pools/abstract-pool.ts:886
  • Returns number

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:760
  • +
  • Defined in src/pools/abstract-pool.ts:1041
  • @@ -47,7 +47,7 @@
  • ClusterWorker
  • ThreadWorker
  • +
  • Defined in src/worker/abstract-worker.ts:39
  • @@ -148,7 +148,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:73
  • Properties

    @@ -158,7 +158,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:63
  • id: number
    @@ -166,7 +166,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:47
  • isMain: boolean
    @@ -174,7 +174,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:75
  • lastTaskTimestamp: number
    @@ -182,7 +182,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:55
  • mainWorker: MainWorker
    @@ -190,7 +190,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:79
  • opts: WorkerOptions = ...
    @@ -198,7 +198,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:80
  • statistics: WorkerStatistics
    @@ -206,7 +206,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:59
  • taskFunctions: Map<string, WorkerFunction<Data, Response>>
    @@ -214,7 +214,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:51
  • Methods

    @@ -248,7 +248,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:177
  • Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:478
  • +
  • Defined in src/worker/abstract-worker.ts:327
  • +
  • Defined in src/worker/abstract-worker.ts:502
  • +
  • Defined in src/worker/abstract-worker.ts:112
  • Returns void

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

    +
  • Defined in src/worker/abstract-worker.ts:487
  • +
  • Defined in src/worker/abstract-worker.ts:341
  • +
  • Defined in src/worker/abstract-worker.ts:469
  • +
  • Defined in src/worker/abstract-worker.ts:363
  • +
  • Defined in src/worker/abstract-worker.ts:159
  • +
  • Defined in src/worker/abstract-worker.ts:276
  • +
  • Defined in src/worker/abstract-worker.ts:215
  • +
  • Defined in src/worker/abstract-worker.ts:373
  • +
  • Defined in src/worker/abstract-worker.ts:426
  • +
  • Defined in src/worker/abstract-worker.ts:388
  • +
  • Defined in src/worker/abstract-worker.ts:353
  • +
  • Defined in src/worker/abstract-worker.ts:243
  • +
  • Defined in src/worker/abstract-worker.ts:308
  • +
  • Defined in src/worker/abstract-worker.ts:320
  • +
  • Defined in src/worker/abstract-worker.ts:301
  • @@ -31,7 +31,7 @@
    • CircularArray
    +
  • Defined in src/circular-array.ts:8
  • @@ -113,7 +113,7 @@

    Returns CircularArray<T>

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

    @@ -153,7 +153,7 @@ when they will be absent when used in a 'with' statement.

    size: number
    +
  • Defined in src/circular-array.ts:9
  • [species]: ArrayConstructor
    +
  • Defined in src/circular-array.ts:88
  • +
  • Defined in src/circular-array.ts:39
  • +
  • Defined in src/circular-array.ts:80
  • +
  • Defined in src/circular-array.ts:84
  • +
  • Defined in src/circular-array.ts:21
  • Returns void

    +
  • Defined in src/circular-array.ts:68
  • +
  • Defined in src/circular-array.ts:54
  • +
  • Defined in src/circular-array.ts:30
  • @@ -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:63
  • isMain: boolean
    @@ -145,7 +145,7 @@ but the minimum number of workers will be guaranteed.

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

    +
  • Defined in src/worker/abstract-worker.ts:55
  • mainWorker: Worker
    @@ -163,7 +163,7 @@ but the minimum number of workers will be guaranteed.

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

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

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

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

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

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

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

    +
  • Defined in src/worker/abstract-worker.ts:177
  • +
  • Defined in src/worker/abstract-worker.ts:341
  • +
  • Defined in src/worker/abstract-worker.ts:363
  • +
  • Defined in src/worker/abstract-worker.ts:159
  • +
  • Defined in src/worker/abstract-worker.ts:276
  • +
  • Defined in src/worker/abstract-worker.ts:215
  • +
  • Defined in src/worker/abstract-worker.ts:373
  • +
  • Defined in src/worker/abstract-worker.ts:426
  • +
  • Defined in src/worker/abstract-worker.ts:388
  • +
  • Defined in src/worker/cluster-worker.ts:52
  • +
  • Defined in src/worker/abstract-worker.ts:243
  • +
  • Defined in src/worker/abstract-worker.ts:301
  • @@ -45,7 +45,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    • DynamicClusterPool
    +
  • Defined in src/pools/cluster/dynamic.ts:15
  • @@ -144,7 +144,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

    @@ -163,7 +163,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:62
  • filePath: string
    @@ -172,7 +172,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:100
  • max: number
    @@ -180,7 +180,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
    @@ -189,7 +189,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:99
  • opts: ClusterPoolOptions = {}
    @@ -198,7 +198,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<Worker, Response>> = ...
    @@ -212,7 +212,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:72
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -221,7 +221,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:80
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -230,7 +230,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:59
  • Accessors

    @@ -245,7 +245,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:48
  • +
  • Defined in src/pools/abstract-pool.ts:566
  • +
  • Defined in src/pools/abstract-pool.ts:272
  • +
  • Defined in src/pools/cluster/dynamic.ts:43
  • +
  • Defined in src/pools/cluster/fixed.ts:92
  • +
  • Defined in src/pools/abstract-pool.ts:416
  • +
  • Defined in src/pools/abstract-pool.ts:408
  • +
  • Defined in src/pools/cluster/dynamic.ts:38
  • +
  • Defined in src/pools/abstract-pool.ts:428
  • +
  • Defined in src/pools/cluster/fixed.ts:87
  • Methods

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

    +
  • Defined in src/pools/abstract-pool.ts:692
  • +
  • Defined in src/pools/abstract-pool.ts:927
  • +
  • Defined in src/pools/abstract-pool.ts:671
  • +
  • Defined in src/pools/abstract-pool.ts:164
  • +
  • Defined in src/pools/abstract-pool.ts:1010
  • +
  • Defined in src/pools/abstract-pool.ts:944
  • +
  • Defined in src/pools/cluster/fixed.ts:77
  • +
  • Defined in src/pools/abstract-pool.ts:626
  • +
  • Defined in src/pools/cluster/fixed.ts:63
  • +
  • Defined in src/pools/abstract-pool.ts:531
  • +
  • Defined in src/pools/abstract-pool.ts:591
  • +
  • Defined in src/pools/abstract-pool.ts:582
  • +
  • Defined in src/pools/cluster/fixed.ts:58
  • +
  • Defined in src/pools/cluster/fixed.ts:72
  • +
  • Defined in src/pools/abstract-pool.ts:543
  • +
  • Defined in src/pools/abstract-pool.ts:501
  • +
  • Defined in src/pools/abstract-pool.ts:520
  • +
  • Defined in src/pools/cluster/fixed.ts:53
  • +
  • Defined in src/pools/abstract-pool.ts:1041
  • @@ -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
  • @@ -144,7 +144,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

    @@ -163,7 +163,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:62
  • filePath: string
    @@ -172,7 +172,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:100
  • max: number
    @@ -180,7 +180,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
    @@ -189,7 +189,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:99
  • @@ -198,7 +198,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/fixed.ts:46
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -212,7 +212,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:72
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -221,7 +221,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:80
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -230,7 +230,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:59
  • Accessors

    @@ -245,7 +245,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/thread/dynamic.ts:48
  • +
  • Defined in src/pools/abstract-pool.ts:566
  • +
  • Defined in src/pools/abstract-pool.ts:272
  • +
  • Defined in src/pools/thread/dynamic.ts:43
  • +
  • Defined in src/pools/thread/fixed.ts:86
  • +
  • Defined in src/pools/abstract-pool.ts:416
  • +
  • Defined in src/pools/abstract-pool.ts:408
  • +
  • Defined in src/pools/thread/dynamic.ts:38
  • +
  • Defined in src/pools/abstract-pool.ts:428
  • +
  • Defined in src/pools/thread/fixed.ts:81
  • Methods

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

    +
  • Defined in src/pools/abstract-pool.ts:692
  • +
  • Defined in src/pools/abstract-pool.ts:927
  • +
  • Defined in src/pools/abstract-pool.ts:671
  • +
  • Defined in src/pools/abstract-pool.ts:164
  • +
  • Defined in src/pools/abstract-pool.ts:1010
  • +
  • Defined in src/pools/abstract-pool.ts:944
  • +
  • Defined in src/pools/thread/fixed.ts:68
  • +
  • Defined in src/pools/abstract-pool.ts:626
  • +
  • Defined in src/pools/thread/fixed.ts:57
  • +
  • Defined in src/pools/abstract-pool.ts:531
  • +
  • Defined in src/pools/abstract-pool.ts:591
  • +
  • Defined in src/pools/abstract-pool.ts:582
  • +
  • Defined in src/pools/thread/fixed.ts:52
  • +
  • Defined in src/pools/thread/fixed.ts:63
  • +
  • Defined in src/pools/abstract-pool.ts:543
  • +
  • Defined in src/pools/abstract-pool.ts:501
  • +
  • Defined in src/pools/abstract-pool.ts:520
  • +
  • Defined in src/pools/abstract-pool.ts:655
  • +
  • Defined in src/pools/abstract-pool.ts:1041
  • @@ -45,7 +45,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:33
  • @@ -138,7 +138,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:44
  • Properties

    @@ -157,7 +157,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62
  • filePath: string
    @@ -166,7 +166,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:100
  • numberOfWorkers: number
    @@ -175,7 +175,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:99
  • @@ -184,7 +184,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:47
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -198,7 +198,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:72
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -207,7 +207,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:80
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -216,7 +216,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:59
  • Accessors

    @@ -231,7 +231,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:102
  • +
  • Defined in src/pools/abstract-pool.ts:566
  • +
  • Defined in src/pools/abstract-pool.ts:272
  • +
  • Defined in src/pools/cluster/fixed.ts:97
  • +
  • Defined in src/pools/cluster/fixed.ts:92
  • +
  • Defined in src/pools/abstract-pool.ts:416
  • +
  • Defined in src/pools/abstract-pool.ts:408
  • +
  • Defined in src/pools/cluster/fixed.ts:82
  • +
  • Defined in src/pools/abstract-pool.ts:428
  • +
  • Defined in src/pools/cluster/fixed.ts:87
  • Methods

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

    +
  • Defined in src/pools/abstract-pool.ts:692
  • +
  • Defined in src/pools/abstract-pool.ts:927
  • +
  • Defined in src/pools/abstract-pool.ts:671
  • +
  • Defined in src/pools/abstract-pool.ts:164
  • +
  • Defined in src/pools/abstract-pool.ts:1010
  • +
  • Defined in src/pools/abstract-pool.ts:944
  • +
  • Defined in src/pools/cluster/fixed.ts:77
  • +
  • Defined in src/pools/abstract-pool.ts:626
  • +
  • Defined in src/pools/cluster/fixed.ts:63
  • +
  • Defined in src/pools/abstract-pool.ts:531
  • +
  • Defined in src/pools/abstract-pool.ts:591
  • +
  • Defined in src/pools/abstract-pool.ts:582
  • +
  • Defined in src/pools/cluster/fixed.ts:58
  • +
  • Defined in src/pools/cluster/fixed.ts:72
  • +
  • Defined in src/pools/abstract-pool.ts:543
  • +
  • Defined in src/pools/abstract-pool.ts:501
  • +
  • Defined in src/pools/abstract-pool.ts:520
  • +
  • Defined in src/pools/cluster/fixed.ts:53
  • +
  • Defined in src/pools/abstract-pool.ts:1041
  • @@ -45,7 +45,7 @@ +
  • Defined in src/pools/thread/fixed.ts:32
  • @@ -138,7 +138,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:43
  • Properties

    @@ -157,7 +157,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62
  • filePath: string
    @@ -166,7 +166,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:100
  • numberOfWorkers: number
    @@ -175,7 +175,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:99
  • @@ -184,7 +184,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:46
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -198,7 +198,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:72
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -207,7 +207,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:80
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -216,7 +216,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:59
  • Accessors

    @@ -231,7 +231,7 @@
    +
  • Defined in src/pools/thread/fixed.ts:96
  • +
  • Defined in src/pools/abstract-pool.ts:566
  • +
  • Defined in src/pools/abstract-pool.ts:272
  • +
  • Defined in src/pools/thread/fixed.ts:91
  • +
  • Defined in src/pools/thread/fixed.ts:86
  • +
  • Defined in src/pools/abstract-pool.ts:416
  • +
  • Defined in src/pools/abstract-pool.ts:408
  • +
  • Defined in src/pools/thread/fixed.ts:76
  • +
  • Defined in src/pools/abstract-pool.ts:428
  • +
  • Defined in src/pools/thread/fixed.ts:81
  • Methods

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

    +
  • Defined in src/pools/abstract-pool.ts:692
  • +
  • Defined in src/pools/abstract-pool.ts:927
  • +
  • Defined in src/pools/abstract-pool.ts:671
  • +
  • Defined in src/pools/abstract-pool.ts:164
  • +
  • Defined in src/pools/abstract-pool.ts:1010
  • +
  • Defined in src/pools/abstract-pool.ts:944
  • +
  • Defined in src/pools/thread/fixed.ts:68
  • +
  • Defined in src/pools/abstract-pool.ts:626
  • +
  • Defined in src/pools/thread/fixed.ts:57
  • +
  • Defined in src/pools/abstract-pool.ts:531
  • +
  • Defined in src/pools/abstract-pool.ts:591
  • +
  • Defined in src/pools/abstract-pool.ts:582
  • +
  • Defined in src/pools/thread/fixed.ts:52
  • +
  • Defined in src/pools/thread/fixed.ts:63
  • +
  • Defined in src/pools/abstract-pool.ts:543
  • +
  • Defined in src/pools/abstract-pool.ts:501
  • +
  • Defined in src/pools/abstract-pool.ts:520
  • +
  • Defined in src/pools/abstract-pool.ts:655
  • +
  • Defined in src/pools/abstract-pool.ts:1041
  • @@ -26,7 +26,7 @@ +
  • Defined in src/pools/pool.ts:38
  • @@ -843,7 +843,7 @@ special handling:

  • once
  • setMaxListeners
  • @@ -32,7 +32,7 @@ +
  • Defined in src/queue.ts:8
  • @@ -71,14 +71,14 @@

    T

    Returns Queue<T>

    +
  • Defined in src/queue.ts:16
  • Properties

    items: T[]
    +
  • Defined in src/queue.ts:9
  • maxSize: number
    @@ -86,12 +86,12 @@
    +
  • Defined in src/queue.ts:14
  • offset: number
    +
  • Defined in src/queue.ts:10
  • size: number
    @@ -99,7 +99,7 @@
    +
  • Defined in src/queue.ts:12
  • Methods

    @@ -115,7 +115,7 @@

    See

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

    +
  • Defined in src/queue.ts:81
  • +
  • Defined in src/queue.ts:68
  • +
  • Defined in src/queue.ts:40
  • +
  • Defined in src/queue.ts:26
  • +
  • Defined in src/queue.ts:58
  • @@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.

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

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

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

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

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

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

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

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

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

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

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

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

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

    +
  • Defined in src/worker/abstract-worker.ts:177
  • +
  • Defined in src/worker/abstract-worker.ts:341
  • +
  • Defined in src/worker/thread-worker.ts:61
  • +
  • Defined in src/worker/abstract-worker.ts:159
  • +
  • Defined in src/worker/abstract-worker.ts:276
  • +
  • Defined in src/worker/abstract-worker.ts:215
  • +
  • Defined in src/worker/abstract-worker.ts:373
  • +
  • Defined in src/worker/abstract-worker.ts:426
  • +
  • Defined in src/worker/abstract-worker.ts:388
  • +
  • Defined in src/worker/thread-worker.ts:56
  • +
  • Defined in src/worker/abstract-worker.ts:243
  • +
  • Defined in src/worker/abstract-worker.ts:301
  • @@ -42,7 +42,7 @@
    • WorkerChoiceStrategyContext
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:27
  • @@ -106,14 +106,14 @@

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

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

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

    @@ -137,7 +137,7 @@

    Throws

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

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:167
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:113
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:126
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:185
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:198
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:139
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:153
  • @@ -26,7 +26,7 @@ Always returns a value greater than zero.

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

    poolifier - v2.6.13

    +

    poolifier - v2.6.14

    Index

    @@ -105,7 +105,7 @@

    Theme

    @@ -26,7 +26,7 @@ +
  • Defined in src/pools/cluster/fixed.ts:10
  • @@ -59,7 +59,7 @@
    +
  • Defined in src/pools/pool.ts:147
  • enableTasksQueue?: boolean
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/pool.ts:153
  • env?: Record<string, unknown>
    @@ -80,7 +80,7 @@

    See

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

    +
  • Defined in src/pools/cluster/fixed.ts:16
  • errorHandler?: ErrorHandler<Worker>
    @@ -89,7 +89,7 @@
    +
  • Defined in src/pools/pool.ts:119
  • exitHandler?: ExitHandler<Worker>
    @@ -98,7 +98,7 @@
    +
  • Defined in src/pools/pool.ts:127
  • messageHandler?: MessageHandler<Worker>
    @@ -107,7 +107,7 @@
    +
  • Defined in src/pools/pool.ts:115
  • onlineHandler?: OnlineHandler<Worker>
    @@ -116,7 +116,7 @@
    +
  • Defined in src/pools/pool.ts:123
  • restartWorkerOnError?: boolean
    @@ -125,7 +125,7 @@
    +
  • Defined in src/pools/pool.ts:141
  • settings?: ClusterSettings
    @@ -135,7 +135,7 @@

    See

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

    +
  • Defined in src/pools/cluster/fixed.ts:22
  • tasksQueueOptions?: TasksQueueOptions
    @@ -144,7 +144,7 @@
    +
  • Defined in src/pools/pool.ts:157
  • workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    @@ -155,7 +155,7 @@
    +
  • Defined in src/pools/pool.ts:133
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/pool.ts:137
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/worker.ts:70
  • @@ -42,17 +42,17 @@
    +
  • Defined in src/pools/worker.ts:72
  • +
  • Defined in src/pools/worker.ts:71
  • utilization?: number
    +
  • Defined in src/pools/worker.ts:73
  • @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:167
  • @@ -81,7 +81,7 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:203
  • emitter?: PoolEmitter
    @@ -97,7 +97,7 @@
    +
  • Defined in src/pools/pool.ts:191
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -126,7 +126,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:228
  • execute: ((data?, name?) => Promise<Response>)
    @@ -156,7 +156,7 @@
    +
  • Defined in src/pools/pool.ts:199
  • info: PoolInfo
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/pool.ts:175
  • setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -188,7 +188,7 @@

    Returns void

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

    Returns void

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

    Returns void

    +
  • Defined in src/pools/pool.ts:219
  • workerNodes: IWorkerNode<Worker, Data>[]
    @@ -249,7 +249,7 @@
    +
  • Defined in src/pools/pool.ts:179
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/worker.ts:168
  • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:172
  • on: ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void)
    @@ -118,7 +118,7 @@

    Param

    The event handler.

    +
  • Defined in src/pools/worker.ts:180
  • once: ((event, handler) => void)
    @@ -147,12 +147,12 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:190
  • threadId?: number
    +
  • Defined in src/pools/worker.ts:173
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:160
  • @@ -58,7 +58,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:186
  • remove: ((workerNodeKey) => boolean)
    @@ -83,7 +83,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:193
  • reset: (() => boolean)
    @@ -100,7 +100,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:174
  • setOptions: ((opts) => void)
    @@ -124,7 +124,7 @@

    Returns void

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:199
  • strategyPolicy: StrategyPolicy
    @@ -132,7 +132,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:164
  • taskStatisticsRequirements: TaskStatisticsRequirements
    @@ -140,7 +140,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:168
  • update: ((workerNodeKey) => boolean)
    @@ -162,7 +162,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:180
  • @@ -37,7 +37,7 @@ +
  • Defined in src/pools/worker.ts:200
  • @@ -72,7 +72,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:235
  • dequeueTask: (() => undefined | Task<Data>)
    @@ -89,7 +89,7 @@
    +
  • Defined in src/pools/worker.ts:231
  • enqueueTask: ((task) => number)
    @@ -114,7 +114,7 @@
    +
  • Defined in src/pools/worker.ts:225
  • getTaskWorkerUsage: ((name) => undefined | WorkerUsage)
    @@ -135,7 +135,7 @@

    Returns undefined | WorkerUsage

    +
  • Defined in src/pools/worker.ts:243
  • info: WorkerInfo
    @@ -143,7 +143,7 @@
    +
  • Defined in src/pools/worker.ts:208
  • resetUsage: (() => void)
    @@ -159,7 +159,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:239
  • tasksQueueSize: (() => number)
    @@ -176,7 +176,7 @@
    +
  • Defined in src/pools/worker.ts:218
  • usage: WorkerUsage
    @@ -184,7 +184,7 @@
    +
  • Defined in src/pools/worker.ts:212
  • worker: Worker
    @@ -192,7 +192,7 @@
    +
  • Defined in src/pools/worker.ts:204
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:61
  • @@ -43,7 +43,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:65
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/worker.ts:38
  • @@ -48,7 +48,7 @@
    +
  • Defined in src/pools/worker.ts:42
  • average?: number
    @@ -56,7 +56,7 @@
    +
  • Defined in src/pools/worker.ts:54
  • history: CircularArray<number>
    @@ -64,7 +64,7 @@
    +
  • Defined in src/pools/worker.ts:62
  • maximum?: number
    @@ -72,7 +72,7 @@
    +
  • Defined in src/pools/worker.ts:50
  • median?: number
    @@ -80,7 +80,7 @@
    +
  • Defined in src/pools/worker.ts:58
  • minimum?: number
    @@ -88,7 +88,7 @@
    +
  • Defined in src/pools/worker.ts:46
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:108
  • @@ -45,7 +45,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:112
  • average: boolean
    @@ -53,7 +53,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:116
  • median: boolean
    @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:120
  • @@ -39,7 +39,7 @@ +
  • Defined in src/utility-types.ts:95
  • @@ -68,7 +68,7 @@
    +
  • Defined in src/utility-types.ts:120
  • data?: Data
    @@ -77,7 +77,7 @@
    +
  • Defined in src/utility-types.ts:77
  • id?: string
    @@ -86,7 +86,7 @@
    +
  • Defined in src/utility-types.ts:85
  • kill?: true | "SOFT" | "HARD"
    @@ -94,7 +94,7 @@
    +
  • Defined in src/utility-types.ts:100
  • name?: string
    @@ -103,7 +103,7 @@
    +
  • Defined in src/utility-types.ts:73
  • ready?: boolean
    @@ -111,7 +111,7 @@
    +
  • Defined in src/utility-types.ts:116
  • statistics?: WorkerStatistics
    @@ -119,7 +119,7 @@
    +
  • Defined in src/utility-types.ts:112
  • taskError?: TaskError<ErrorData>
    @@ -127,7 +127,7 @@
    +
  • Defined in src/utility-types.ts:104
  • taskPerformance?: TaskPerformance
    @@ -135,7 +135,7 @@
    +
  • Defined in src/utility-types.ts:108
  • timestamp?: number
    @@ -144,7 +144,7 @@
    +
  • Defined in src/utility-types.ts:81
  • workerId: number
    @@ -153,7 +153,7 @@
    +
  • Defined in src/utility-types.ts:69
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/pool.ts:59
  • @@ -60,22 +60,22 @@
    +
  • Defined in src/pools/pool.ts:74
  • executedTasks: number
    +
  • Defined in src/pools/pool.ts:75
  • executingTasks: number
    +
  • Defined in src/pools/pool.ts:76
  • failedTasks: number
    +
  • Defined in src/pools/pool.ts:79
  • idleWorkerNodes: number
    @@ -83,32 +83,32 @@
    +
  • Defined in src/pools/pool.ts:72
  • maxQueuedTasks: number
    +
  • Defined in src/pools/pool.ts:78
  • maxSize: number
    +
  • Defined in src/pools/pool.ts:66
  • minSize: number
    +
  • Defined in src/pools/pool.ts:65
  • queuedTasks: number
    +
  • Defined in src/pools/pool.ts:77
  • ready: boolean
    +
  • Defined in src/pools/pool.ts:63
  • runTime?: {
        average: number;
        maximum: number;
        median?: number;
        minimum: number;
    }
    @@ -124,17 +124,17 @@
  • Readonly minimum: number
  • +
  • Defined in src/pools/pool.ts:80
  • strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    +
  • Defined in src/pools/pool.ts:64
  • type: "fixed" | "dynamic"
    +
  • Defined in src/pools/pool.ts:61
  • utilization?: number
    @@ -142,12 +142,12 @@
    +
  • Defined in src/pools/pool.ts:68
  • version: string
    +
  • Defined in src/pools/pool.ts:60
  • waitTime?: {
        average: number;
        maximum: number;
        median?: number;
        minimum: number;
    }
    @@ -163,12 +163,12 @@
  • Readonly minimum: number
  • +
  • Defined in src/pools/pool.ts:86
  • worker: "cluster" | "thread"
    +
  • Defined in src/pools/pool.ts:62
  • workerNodes: number
    @@ -176,7 +176,7 @@
    +
  • Defined in src/pools/pool.ts:70
  • @@ -35,7 +35,7 @@
  • ClusterPoolOptions
  • ThreadPoolOptions
  • +
  • Defined in src/pools/pool.ts:111
  • @@ -65,7 +65,7 @@

    Default Value

    true

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

    Default Value

    false

    +
  • Defined in src/pools/pool.ts:153
  • errorHandler?: ErrorHandler<Worker>
    @@ -83,7 +83,7 @@
    +
  • Defined in src/pools/pool.ts:119
  • exitHandler?: ExitHandler<Worker>
    @@ -91,7 +91,7 @@
    +
  • Defined in src/pools/pool.ts:127
  • messageHandler?: MessageHandler<Worker>
    @@ -99,7 +99,7 @@
    +
  • Defined in src/pools/pool.ts:115
  • onlineHandler?: OnlineHandler<Worker>
    @@ -107,7 +107,7 @@
    +
  • Defined in src/pools/pool.ts:123
  • restartWorkerOnError?: boolean
    @@ -115,7 +115,7 @@
    +
  • Defined in src/pools/pool.ts:141
  • tasksQueueOptions?: TasksQueueOptions
    @@ -123,7 +123,7 @@
    +
  • Defined in src/pools/pool.ts:157
  • workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    @@ -133,7 +133,7 @@

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN

    +
  • Defined in src/pools/pool.ts:133
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -141,7 +141,7 @@
    +
  • Defined in src/pools/pool.ts:137
  • @@ -37,7 +37,7 @@ +
  • Defined in src/utility-types.ts:130
  • @@ -71,7 +71,7 @@

    Returns void

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

    Returns void

    +
  • Defined in src/utility-types.ts:137
  • worker: Worker
    @@ -100,7 +100,7 @@
    +
  • Defined in src/utility-types.ts:145
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:148
  • @@ -43,7 +43,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:152
  • @@ -34,7 +34,7 @@ +
  • Defined in src/utility-types.ts:65
  • @@ -57,7 +57,7 @@
    +
  • Defined in src/utility-types.ts:77
  • id?: string
    @@ -65,7 +65,7 @@
    +
  • Defined in src/utility-types.ts:85
  • name?: string
    @@ -73,7 +73,7 @@
    +
  • Defined in src/utility-types.ts:73
  • timestamp?: number
    @@ -81,7 +81,7 @@
    +
  • Defined in src/utility-types.ts:81
  • workerId: number
    @@ -89,7 +89,7 @@
    +
  • Defined in src/utility-types.ts:69
  • @@ -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:81
  • @@ -47,7 +47,7 @@
    +
  • Defined in src/pools/worker.ts:85
  • executing: number
    @@ -55,7 +55,7 @@
    +
  • Defined in src/pools/worker.ts:89
  • failed: number
    @@ -63,7 +63,7 @@
    +
  • Defined in src/pools/worker.ts:101
  • maxQueued?: number
    @@ -71,7 +71,7 @@
    +
  • Defined in src/pools/worker.ts:97
  • queued: number
    @@ -79,7 +79,7 @@
    +
  • Defined in src/pools/worker.ts:93
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:128
  • @@ -45,7 +45,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:140
  • @@ -53,7 +53,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:132
  • waitTime: MeasurementStatisticsRequirements
    @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:136
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/pool.ts:97
  • @@ -45,7 +45,7 @@

    Default Value

    1

    +
  • Defined in src/pools/pool.ts:103
  • @@ -26,7 +26,7 @@ +
  • Defined in src/pools/thread/fixed.ts:15
  • @@ -58,7 +58,7 @@
    +
  • Defined in src/pools/pool.ts:147
  • enableTasksQueue?: boolean
    @@ -69,7 +69,7 @@
    +
  • Defined in src/pools/pool.ts:153
  • errorHandler?: ErrorHandler<Worker>
    @@ -78,7 +78,7 @@
    +
  • Defined in src/pools/pool.ts:119
  • exitHandler?: ExitHandler<Worker>
    @@ -87,7 +87,7 @@
    +
  • Defined in src/pools/pool.ts:127
  • messageHandler?: MessageHandler<Worker>
    @@ -96,7 +96,7 @@
    +
  • Defined in src/pools/pool.ts:115
  • onlineHandler?: OnlineHandler<Worker>
    @@ -105,7 +105,7 @@
    +
  • Defined in src/pools/pool.ts:123
  • restartWorkerOnError?: boolean
    @@ -114,7 +114,7 @@
    +
  • Defined in src/pools/pool.ts:141
  • tasksQueueOptions?: TasksQueueOptions
    @@ -123,7 +123,7 @@
    +
  • Defined in src/pools/pool.ts:157
  • workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    @@ -134,7 +134,7 @@
    +
  • Defined in src/pools/pool.ts:133
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -143,7 +143,7 @@
    +
  • Defined in src/pools/pool.ts:137
  • workerOptions?: WorkerOptions
    @@ -153,7 +153,7 @@

    See

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

    +
  • Defined in src/pools/thread/fixed.ts:21
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:71
  • @@ -49,7 +49,7 @@

    Default Value

    { median: false }

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

    Default Value

    { median: false }

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

    Default Value

    { median: false }

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:87
  • weights?: Record<number, number>
    @@ -88,7 +88,7 @@ Weight is the tasks maximum average or median runtime in milliseconds.

    Default Value

    Computed worker weights automatically given the CPU performance.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:100
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/worker.ts:122
  • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:134
  • id: undefined | number
    @@ -54,7 +54,7 @@
    +
  • Defined in src/pools/worker.ts:126
  • ready: boolean
    @@ -62,7 +62,7 @@
    +
  • Defined in src/pools/worker.ts:138
  • type: "cluster" | "thread"
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:130
  • @@ -24,7 +24,7 @@ +
  • Defined in src/worker/worker-options.ts:23
  • @@ -49,7 +49,7 @@

    Deprecated

    This option will be removed in the next major version.

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

    Default Value

    KillBehaviors.SOFT

    +
  • Defined in src/worker/worker-options.ts:54
  • maxInactiveTime?: number
    @@ -81,7 +81,7 @@ when this timeout expires your tasks is interrupted and the worker is killed if

    Default Value

    60000

    +
  • Defined in src/worker/worker-options.ts:36
  • @@ -24,7 +24,7 @@ +
  • Defined in src/utility-types.ts:54
  • @@ -41,12 +41,12 @@
    elu: boolean
    +
  • Defined in src/utility-types.ts:56
  • runTime: boolean
    +
  • Defined in src/utility-types.ts:55
  • @@ -24,7 +24,7 @@ +
  • Defined in src/pools/worker.ts:146
  • @@ -46,7 +46,7 @@
    +
  • Defined in src/pools/worker.ts:162
  • @@ -54,7 +54,7 @@
    +
  • Defined in src/pools/worker.ts:154
  • tasks: TaskStatistics
    @@ -62,7 +62,7 @@
    +
  • Defined in src/pools/worker.ts:150
  • waitTime: MeasurementStatistics
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:158
  • @@ -40,7 +40,7 @@

    Returns void

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

    Returns void

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

    Returns void

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

    Returns void

    +
  • Defined in src/pools/worker.ts:23
  • @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/pool.ts:54
  • @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/pool.ts:33
  • @@ -36,7 +36,7 @@ The value is the function itself.

    +
  • Defined in src/worker/worker-functions.ts:42
  • @@ -47,7 +47,7 @@ This function must return a promise.

    Returns Promise<Response>

    +
  • Defined in src/worker/worker-functions.ts:18
  • @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:42
  • @@ -34,7 +34,7 @@ This function can be synchronous or asynchronous.

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

    Returns Response

    +
  • Defined in src/worker/worker-functions.ts:7
  • @@ -20,7 +20,7 @@
    +
  • Defined in src/pools/worker.ts:115
  • @@ -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:47
  • @@ -33,7 +33,7 @@
    Readonly taskError: "taskError"
    +
  • Defined in src/pools/pool.ts:43
  • @@ -33,7 +33,7 @@
    +
  • Defined in src/pools/pool.ts:19
  • @@ -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:107