From f63918da6f3fc77cc7f98e4d43e3f37955140468 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 15 Apr 2023 13:05:36 +0000 Subject: [PATCH] chore: generate documentation --- docs/classes/AbstractPool.html | 114 +++++++++--------- docs/classes/AbstractWorker.html | 32 ++--- docs/classes/CircularArray.html | 22 ++-- docs/classes/ClusterWorker.html | 28 ++--- docs/classes/DynamicClusterPool.html | 76 ++++++------ docs/classes/DynamicThreadPool.html | 76 ++++++------ docs/classes/FixedClusterPool.html | 74 ++++++------ docs/classes/FixedThreadPool.html | 74 ++++++------ docs/classes/PoolEmitter.html | 2 +- docs/classes/ThreadWorker.html | 28 ++--- docs/classes/WorkerChoiceStrategyContext.html | 18 +-- docs/enums/PoolType.html | 6 +- docs/interfaces/ClusterPoolOptions.html | 26 ++-- docs/interfaces/IPool.html | 26 ++-- docs/interfaces/IWorker.html | 6 +- docs/interfaces/IWorkerChoiceStrategy.html | 12 +- docs/interfaces/MessageValue.html | 16 +-- docs/interfaces/PoolOptions.html | 22 ++-- docs/interfaces/PromiseResponseWrapper.html | 8 +- docs/interfaces/RequiredStatistics.html | 8 +- docs/interfaces/Task.html | 8 +- docs/interfaces/TasksQueueOptions.html | 4 +- docs/interfaces/TasksUsage.html | 16 +-- .../WorkerChoiceStrategyOptions.html | 6 +- docs/interfaces/WorkerNode.html | 8 +- docs/interfaces/WorkerOptions.html | 8 +- docs/types/Draft.html | 2 +- docs/types/ErrorHandler.html | 2 +- docs/types/ExitHandler.html | 2 +- docs/types/KillBehavior.html | 2 +- docs/types/MessageHandler.html | 2 +- docs/types/OnlineHandler.html | 2 +- docs/types/PoolEvent.html | 2 +- .../types/ThreadWorkerWithMessageChannel.html | 2 +- docs/types/WorkerChoiceStrategy.html | 2 +- docs/variables/KillBehaviors.html | 2 +- docs/variables/PoolEvents.html | 2 +- docs/variables/WorkerChoiceStrategies.html | 2 +- 38 files changed, 377 insertions(+), 371 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 400bbdf3..3017080f 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -45,7 +45,7 @@ +
  • Defined in src/pools/abstract-pool.ts:33
  • @@ -142,7 +142,7 @@
  • filePath: string
    -

    Path to the worker-file.

    +

    Path to the worker file.

  • opts: PoolOptions<Worker>
    @@ -150,7 +150,7 @@
  • Returns AbstractPool<Worker, Data, Response>

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

    @@ -165,28 +165,28 @@
    +
  • Defined in src/pools/abstract-pool.ts:42
  • filePath: string
    -

    Path to the worker-file.

    +

    Path to the worker file.

    +
  • Defined in src/pools/abstract-pool.ts:77
  • numberOfWorkers: number

    Number of workers that this pool should manage.

    +
  • Defined in src/pools/abstract-pool.ts:76
  • opts: PoolOptions<Worker>

    Options for the pool.

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

    When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

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

    Default to a round robin algorithm.

    +
  • Defined in src/pools/abstract-pool.ts:62
  • workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -214,7 +214,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:39
  • Accessors

    @@ -227,7 +227,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:298
  • +
  • Defined in src/pools/abstract-pool.ts:291
  • +
  • Defined in src/pools/abstract-pool.ts:195
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/abstract-pool.ts:180
  • Methods

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

    Returns void

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

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

    +
  • Defined in src/pools/abstract-pool.ts:380
  • Returns TasksQueueOptions

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:157
  • +
  • Defined in src/pools/abstract-pool.ts:424
  • +
  • Defined in src/pools/abstract-pool.ts:486
  • +
  • Defined in src/pools/abstract-pool.ts:470
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:639
  • +
  • Defined in src/pools/abstract-pool.ts:343
  • Returns void | Promise<void>

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:211
  • Returns undefined | TasksUsage

    +
  • Defined in src/pools/abstract-pool.ts:568
  • +
  • Defined in src/pools/abstract-pool.ts:300
  • +
  • Defined in src/pools/abstract-pool.ts:372
  • Returns number

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

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

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

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

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

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

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

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

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

    +
  • Defined in src/worker/abstract-worker.ts:105
  • +
  • Defined in src/worker/abstract-worker.ts:136
  • Returns string

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

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

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

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

    +
  • Defined in src/worker/abstract-worker.ts:148
  • +
  • Defined in src/circular-array.ts:8
  • @@ -112,7 +112,7 @@

    Returns CircularArray<T>

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

    @@ -148,7 +148,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:84
  • +
  • Defined in src/circular-array.ts:36
  • +
  • Defined in src/circular-array.ts:76
  • +
  • Defined in src/circular-array.ts:80
  • +
  • Defined in src/circular-array.ts:20
  • Returns void

    +
  • Defined in src/circular-array.ts:64
  • +
  • Defined in src/circular-array.ts:50
  • +
  • Defined in src/circular-array.ts:28
  • +
  • Defined in src/worker/cluster-worker.ts:21
  • @@ -119,7 +119,7 @@ but the minimum number of workers will be guaranteed.

    Returns ClusterWorker<Data, Response>

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

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

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

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

    +
  • Defined in src/worker/abstract-worker.ts:27
  • mainWorker: undefined | null | Worker
    @@ -153,7 +153,7 @@ but the minimum number of workers will be guaranteed.

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

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

    @@ -213,7 +213,7 @@ the AsyncResource to which the function is bound.

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:153
  • +
  • Defined in src/worker/abstract-worker.ts:136
  • +
  • Defined in src/worker/cluster-worker.ts:50
  • +
  • Defined in src/worker/abstract-worker.ts:84
  • +
  • Defined in src/worker/abstract-worker.ts:178
  • +
  • Defined in src/worker/abstract-worker.ts:205
  • +
  • Defined in src/worker/cluster-worker.ts:45
  • +
  • Defined in src/pools/cluster/dynamic.ts:16
  • @@ -132,7 +132,7 @@ When the maximum number of workers is reached and workers are busy, an event is

    Returns DynamicClusterPool<Data, Response>

    +
  • Defined in src/pools/cluster/dynamic.ts:28
  • Properties

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

    Path to the worker-file.

    +

    Path to the worker file.

    +
  • Defined in src/pools/abstract-pool.ts:77
  • max: number

    Maximum number of workers that can be created by this pool.

    +
  • Defined in src/pools/cluster/dynamic.ts:30
  • numberOfWorkers: number
    @@ -170,7 +170,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:76
  • opts: ClusterPoolOptions = {}
    @@ -178,7 +178,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/fixed.ts:53
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -191,7 +191,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:52
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -200,7 +200,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:62
  • workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -208,7 +208,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:39
  • Accessors

    @@ -222,7 +222,7 @@ When the maximum number of workers is reached and workers are busy, an event is

    Returns boolean

    +
  • Defined in src/pools/cluster/dynamic.ts:48
  • +
  • Defined in src/pools/cluster/dynamic.ts:43
  • +
  • Defined in src/pools/abstract-pool.ts:195
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/cluster/dynamic.ts:38
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:391
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/abstract-pool.ts:380
  • +
  • Defined in src/pools/abstract-pool.ts:424
  • +
  • Defined in src/pools/abstract-pool.ts:486
  • +
  • Defined in src/pools/cluster/fixed.ts:88
  • +
  • Defined in src/pools/abstract-pool.ts:343
  • +
  • Defined in src/pools/cluster/fixed.ts:69
  • +
  • Defined in src/pools/abstract-pool.ts:254
  • +
  • Defined in src/pools/abstract-pool.ts:312
  • +
  • Defined in src/pools/abstract-pool.ts:305
  • +
  • Defined in src/pools/abstract-pool.ts:300
  • +
  • Defined in src/pools/cluster/fixed.ts:64
  • +
  • Defined in src/pools/cluster/fixed.ts:80
  • +
  • Defined in src/pools/cluster/fixed.ts:75
  • +
  • Defined in src/pools/abstract-pool.ts:268
  • +
  • Defined in src/pools/abstract-pool.ts:218
  • +
  • Defined in src/pools/abstract-pool.ts:244
  • +
  • Defined in src/pools/cluster/fixed.ts:59
  • +
  • Defined in src/pools/abstract-pool.ts:509
  • +
  • Defined in src/pools/abstract-pool.ts:76
  • @@ -178,7 +178,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:78
  • promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -191,7 +191,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:52
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -200,7 +200,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:62
  • workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    @@ -208,7 +208,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:39
  • Accessors

    @@ -222,7 +222,7 @@ When the maximum number of threads is reached and workers are busy, an event is

    Returns boolean

    +
  • Defined in src/pools/thread/dynamic.ts:49
  • +
  • Defined in src/pools/thread/dynamic.ts:44
  • +
  • Defined in src/pools/abstract-pool.ts:195
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/thread/dynamic.ts:39
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:391
  • +
  • Defined in src/pools/thread/fixed.ts:85
  • +
  • Defined in src/pools/abstract-pool.ts:380
  • +
  • Defined in src/pools/abstract-pool.ts:424
  • +
  • Defined in src/pools/abstract-pool.ts:486
  • +
  • Defined in src/pools/thread/fixed.ts:78
  • +
  • Defined in src/pools/abstract-pool.ts:343
  • +
  • Defined in src/pools/thread/fixed.ts:54
  • +
  • Defined in src/pools/abstract-pool.ts:254
  • +
  • Defined in src/pools/abstract-pool.ts:312
  • +
  • Defined in src/pools/abstract-pool.ts:305
  • +
  • Defined in src/pools/abstract-pool.ts:300
  • +
  • Defined in src/pools/thread/fixed.ts:49
  • +
  • Defined in src/pools/thread/fixed.ts:70
  • +
  • Defined in src/pools/thread/fixed.ts:62
  • +
  • Defined in src/pools/abstract-pool.ts:268
  • +
  • Defined in src/pools/abstract-pool.ts:218
  • +
  • Defined in src/pools/abstract-pool.ts:244
  • +
  • Defined in src/pools/abstract-pool.ts:365
  • +
  • Defined in src/pools/abstract-pool.ts:509
  • +
  • Defined in src/pools/abstract-pool.ts:76
  • @@ -168,7 +168,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:53
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -181,7 +181,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:52
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -190,7 +190,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62
  • workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -198,7 +198,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:39
  • Accessors

    @@ -212,7 +212,7 @@

    Returns boolean

    +
  • Defined in src/pools/cluster/fixed.ts:109
  • +
  • Defined in src/pools/cluster/fixed.ts:104
  • +
  • Defined in src/pools/abstract-pool.ts:195
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/cluster/fixed.ts:99
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:391
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/abstract-pool.ts:380
  • +
  • Defined in src/pools/abstract-pool.ts:424
  • +
  • Defined in src/pools/abstract-pool.ts:486
  • +
  • Defined in src/pools/cluster/fixed.ts:88
  • +
  • Defined in src/pools/abstract-pool.ts:343
  • +
  • Defined in src/pools/cluster/fixed.ts:69
  • +
  • Defined in src/pools/abstract-pool.ts:254
  • +
  • Defined in src/pools/abstract-pool.ts:312
  • +
  • Defined in src/pools/abstract-pool.ts:305
  • +
  • Defined in src/pools/abstract-pool.ts:300
  • +
  • Defined in src/pools/cluster/fixed.ts:64
  • +
  • Defined in src/pools/cluster/fixed.ts:80
  • +
  • Defined in src/pools/cluster/fixed.ts:75
  • +
  • Defined in src/pools/abstract-pool.ts:268
  • +
  • Defined in src/pools/abstract-pool.ts:218
  • +
  • Defined in src/pools/abstract-pool.ts:244
  • +
  • Defined in src/pools/cluster/fixed.ts:59
  • +
  • Defined in src/pools/abstract-pool.ts:509
  • +
  • Defined in src/pools/abstract-pool.ts:76
  • @@ -168,7 +168,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:78
  • promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -181,7 +181,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:52
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -190,7 +190,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:62
  • workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    @@ -198,7 +198,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:39
  • Accessors

    @@ -212,7 +212,7 @@

    Returns boolean

    +
  • Defined in src/pools/thread/fixed.ts:105
  • +
  • Defined in src/pools/thread/fixed.ts:100
  • +
  • Defined in src/pools/abstract-pool.ts:195
  • +
  • Defined in src/pools/abstract-pool.ts:185
  • +
  • Defined in src/pools/thread/fixed.ts:95
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:391
  • +
  • Defined in src/pools/thread/fixed.ts:85
  • +
  • Defined in src/pools/abstract-pool.ts:380
  • +
  • Defined in src/pools/abstract-pool.ts:424
  • +
  • Defined in src/pools/abstract-pool.ts:486
  • +
  • Defined in src/pools/thread/fixed.ts:78
  • +
  • Defined in src/pools/abstract-pool.ts:343
  • +
  • Defined in src/pools/thread/fixed.ts:54
  • +
  • Defined in src/pools/abstract-pool.ts:254
  • +
  • Defined in src/pools/abstract-pool.ts:312
  • +
  • Defined in src/pools/abstract-pool.ts:305
  • +
  • Defined in src/pools/abstract-pool.ts:300
  • +
  • Defined in src/pools/thread/fixed.ts:49
  • +
  • Defined in src/pools/thread/fixed.ts:70
  • +
  • Defined in src/pools/thread/fixed.ts:62
  • +
  • Defined in src/pools/abstract-pool.ts:268
  • +
  • Defined in src/pools/abstract-pool.ts:218
  • +
  • Defined in src/pools/abstract-pool.ts:244
  • +
  • Defined in src/pools/abstract-pool.ts:365
  • +
  • Defined in src/pools/abstract-pool.ts:509
  • +
  • Defined in src/worker/abstract-worker.ts:43
  • lastTaskTimestamp: number
    @@ -145,7 +145,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:27
  • mainWorker: undefined | null | MessagePort
    @@ -153,7 +153,7 @@ but the minimum number of workers will be guaranteed.

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

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

    @@ -213,7 +213,7 @@ the AsyncResource to which the function is bound.

    Returns void

    +
  • Defined in src/worker/abstract-worker.ts:153
  • +
  • Defined in src/worker/abstract-worker.ts:136
  • +
  • Defined in src/worker/abstract-worker.ts:168
  • +
  • Defined in src/worker/abstract-worker.ts:84
  • +
  • Defined in src/worker/abstract-worker.ts:178
  • +
  • Defined in src/worker/abstract-worker.ts:205
  • +
  • Defined in src/worker/thread-worker.ts:39
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:24
  • @@ -96,21 +96,21 @@

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

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

    workerChoiceStrategies: Map<"ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:29
  • workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

    The worker choice strategy.

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

    @@ -124,7 +124,7 @@

    Returns number

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:109
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:82
  • Returns boolean

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

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

    +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:95
  • +
  • Defined in src/pools/pool.ts:105
  • env?: any
    @@ -75,7 +75,7 @@

    See

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

    +
  • Defined in src/pools/cluster/fixed.ts:18
  • errorHandler?: ErrorHandler<Worker>
    @@ -83,7 +83,7 @@
    +
  • Defined in src/pools/pool.ts:75
  • exitHandler?: ExitHandler<Worker>
    @@ -91,7 +91,7 @@
    +
  • Defined in src/pools/pool.ts:83
  • messageHandler?: MessageHandler<Worker>
    @@ -99,7 +99,7 @@
    +
  • Defined in src/pools/pool.ts:71
  • onlineHandler?: OnlineHandler<Worker>
    @@ -107,7 +107,7 @@
    +
  • Defined in src/pools/pool.ts:79
  • settings?: ClusterSettings
    @@ -116,7 +116,7 @@

    See

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

    +
  • Defined in src/pools/cluster/fixed.ts:24
  • tasksQueueOptions?: TasksQueueOptions
    @@ -124,15 +124,17 @@
    +
  • Defined in src/pools/pool.ts:109
  • workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

    The worker choice strategy to use in this pool.

    + +

    Default Value

    'ROUND_ROBIN'

    +
  • Defined in src/pools/pool.ts:89
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -140,7 +142,7 @@
    +
  • Defined in src/pools/pool.ts:93
  • +
  • Defined in src/pools/pool.ts:163
  • emitter?: PoolEmitter
    @@ -89,7 +89,7 @@
    +
  • Defined in src/pools/pool.ts:142
  • enableTasksQueue: ((enable: boolean, tasksQueueOptions?: TasksQueueOptions) => void)
    @@ -115,7 +115,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:188
  • execute: ((data: Data) => Promise<Response>)
    @@ -126,7 +126,7 @@
    +
  • Defined in src/pools/pool.ts:159
  • findFreeWorkerNodeKey: (() => number)
    @@ -158,7 +158,7 @@

    Returns number

    +
  • Defined in src/pools/pool.ts:152
  • setTasksQueueOptions: ((tasksQueueOptions: TasksQueueOptions) => void)
    @@ -180,7 +180,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:197
  • setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions) => void)
    @@ -206,7 +206,7 @@

    Returns void

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

    Returns void

    +
  • Defined in src/pools/pool.ts:179
  • type: PoolType
    @@ -236,14 +236,14 @@

    If it is 'dynamic', it provides the max property.

    +
  • Defined in src/pools/pool.ts:129
  • workerNodes: WorkerNode<Worker, Data>[]

    Pool worker nodes.

    +
  • Defined in src/pools/pool.ts:133
  • Returns void

    +
  • Defined in src/pools/worker.ts:105
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:79
  • remove: ((workerNodeKey: number) => boolean)
    @@ -75,14 +75,14 @@

    Returns boolean

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:85
  • requiredStatistics: RequiredStatistics

    Required tasks usage statistics.

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:71
  • reset: (() => boolean)
    @@ -97,7 +97,7 @@

    Returns boolean

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:75
  • setOptions: ((opts: WorkerChoiceStrategyOptions) => void)
    @@ -119,7 +119,7 @@

    Returns void

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:91
  • +
  • Defined in src/utility-types.ts:35
  • +
  • Defined in src/pools/pool.ts:105
  • errorHandler?: ErrorHandler<Worker>

    A function that will listen for error event on each worker.

    +
  • Defined in src/pools/pool.ts:75
  • exitHandler?: ExitHandler<Worker>

    A function that will listen for exit event on each worker.

    +
  • Defined in src/pools/pool.ts:83
  • messageHandler?: MessageHandler<Worker>

    A function that will listen for message event on each worker.

    +
  • Defined in src/pools/pool.ts:71
  • onlineHandler?: OnlineHandler<Worker>

    A function that will listen for online event on each worker.

    +
  • Defined in src/pools/pool.ts:79
  • tasksQueueOptions?: TasksQueueOptions

    Pool worker tasks queue options.

    +
  • Defined in src/pools/pool.ts:109
  • workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

    The worker choice strategy to use in this pool.

    + +

    Default Value

    'ROUND_ROBIN'

    +
  • Defined in src/pools/pool.ts:89
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    +
  • Defined in src/pools/pool.ts:93
  • +
  • Defined in src/utility-types.ts:60
  • resolve: ((value: Response) => void)
    @@ -87,14 +87,14 @@
    value: Response

    Returns void

    +
  • Defined in src/utility-types.ts:56
  • worker: Worker

    The worker handling the execution.

    +
  • Defined in src/utility-types.ts:64
  • +
  • Defined in src/pools/pool.ts:59
  • +
  • Defined in src/worker/worker-options.ts:68
  • maxInactiveTime?: number
    @@ -75,7 +75,7 @@ when this timeout expires your tasks is interrupted and the worker is killed if

    Default Value

    60000 ms

    +
  • Defined in src/worker/worker-options.ts:51
  • +
  • Defined in src/pools/worker.ts:14
  • +
  • Defined in src/pools/worker.ts:27
  • +
  • Defined in src/pools/worker.ts:6
  • +
  • Defined in src/pools/worker.ts:22