From cea16128a949e8f118627f00ccb33b08db281c45 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 12 Apr 2023 20:25:31 +0000 Subject: [PATCH] chore: generate documentation --- docs/classes/AbstractPool.html | 96 +++++++++---------- docs/classes/AbstractWorker.html | 32 +++---- docs/classes/CircularArray.html | 22 ++--- docs/classes/ClusterWorker.html | 28 +++--- docs/classes/DynamicClusterPool.html | 64 ++++++------- docs/classes/DynamicThreadPool.html | 64 ++++++------- docs/classes/FixedClusterPool.html | 62 ++++++------ docs/classes/FixedThreadPool.html | 62 ++++++------ docs/classes/PoolEmitter.html | 2 +- docs/classes/ThreadWorker.html | 28 +++--- docs/classes/WorkerChoiceStrategyContext.html | 16 ++-- docs/enums/PoolType.html | 6 +- docs/interfaces/ClusterPoolOptions.html | 24 ++--- docs/interfaces/IPool.html | 16 ++-- docs/interfaces/IWorker.html | 6 +- docs/interfaces/IWorkerChoiceStrategy.html | 10 +- docs/interfaces/MessageValue.html | 14 +-- docs/interfaces/PoolOptions.html | 20 ++-- docs/interfaces/PromiseResponseWrapper.html | 8 +- docs/interfaces/RequiredStatistics.html | 8 +- docs/interfaces/Task.html | 6 +- docs/interfaces/TasksQueueOptions.html | 4 +- docs/interfaces/TasksUsage.html | 18 ++-- .../WorkerChoiceStrategyOptions.html | 4 +- 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, 330 insertions(+), 330 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 5cc04560..8582d122 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -45,7 +45,7 @@ +
  • Defined in src/pools/abstract-pool.ts:32
  • @@ -145,7 +145,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

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

    Path to the worker-file.

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

    Number of workers that this pool should manage.

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

    Options for the pool.

    +
  • Defined in src/pools/abstract-pool.ts:77
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -193,7 +193,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:51
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -201,7 +201,7 @@

    Default to a round robin algorithm.

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

    @@ -222,7 +222,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:242
  • +
  • Defined in src/pools/abstract-pool.ts:235
  • +
  • Defined in src/pools/abstract-pool.ts:186
  • +
  • Defined in src/pools/abstract-pool.ts:176
  • +
  • Defined in src/pools/abstract-pool.ts:171
  • Methods

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

    Returns void

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

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:160
  • +
  • Defined in src/pools/abstract-pool.ts:368
  • +
  • Defined in src/pools/abstract-pool.ts:430
  • +
  • Defined in src/pools/abstract-pool.ts:414
  • Returns undefined | Task<Data>

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

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

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:512
  • +
  • Defined in src/pools/abstract-pool.ts:244
  • +
  • Defined in src/pools/abstract-pool.ts:316
  • Returns number

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

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

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:453
  • 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:129
  • Returns string

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

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

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

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

    +
  • Defined in src/worker/abstract-worker.ts:141
  • +
  • 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:146
  • +
  • Defined in src/worker/abstract-worker.ts:129
  • +
  • Defined in src/worker/cluster-worker.ts:47
  • +
  • Defined in src/worker/abstract-worker.ts:84
  • +
  • Defined in src/worker/abstract-worker.ts:171
  • +
  • Defined in src/worker/abstract-worker.ts:198
  • +
  • Defined in src/worker/cluster-worker.ts:42
  • +
  • Defined in src/pools/cluster/dynamic.ts:16
  • @@ -129,7 +129,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

    @@ -144,7 +144,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:41
  • filePath: string
    @@ -152,14 +152,14 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:76
  • max: number

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

    +
  • Defined in src/pools/cluster/dynamic.ts:30
  • numberOfWorkers: number
    @@ -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:75
  • opts: ClusterPoolOptions = {}
    @@ -175,7 +175,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>> = ...
    @@ -188,7 +188,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:51
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -197,7 +197,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:61
  • workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -205,7 +205,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:38
  • Accessors

    @@ -219,7 +219,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:186
  • +
  • Defined in src/pools/abstract-pool.ts:176
  • +
  • Defined in src/pools/cluster/dynamic.ts:38
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:335
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/abstract-pool.ts:324
  • +
  • Defined in src/pools/abstract-pool.ts:368
  • +
  • Defined in src/pools/abstract-pool.ts:430
  • +
  • Defined in src/pools/cluster/fixed.ts:88
  • +
  • Defined in src/pools/abstract-pool.ts:287
  • +
  • Defined in src/pools/cluster/fixed.ts:69
  • +
  • Defined in src/pools/abstract-pool.ts:256
  • +
  • Defined in src/pools/abstract-pool.ts:249
  • +
  • Defined in src/pools/abstract-pool.ts:244
  • +
  • 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:209
  • +
  • Defined in src/pools/cluster/fixed.ts:59
  • +
  • Defined in src/pools/abstract-pool.ts:453
  • +
  • Defined in src/pools/abstract-pool.ts:76
  • max: number

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

    +
  • Defined in src/pools/thread/dynamic.ts:31
  • numberOfWorkers: number
    @@ -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:75
  • opts: PoolOptions<ThreadWorkerWithMessageChannel>
    @@ -175,7 +175,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:77
  • promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -188,7 +188,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:51
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -197,7 +197,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:61
  • workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    @@ -205,7 +205,7 @@ When the maximum number of threads is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:38
  • Accessors

    @@ -219,7 +219,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:186
  • +
  • Defined in src/pools/abstract-pool.ts:176
  • +
  • Defined in src/pools/thread/dynamic.ts:39
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:335
  • +
  • Defined in src/pools/thread/fixed.ts:85
  • +
  • Defined in src/pools/abstract-pool.ts:324
  • +
  • Defined in src/pools/abstract-pool.ts:368
  • +
  • Defined in src/pools/abstract-pool.ts:430
  • +
  • Defined in src/pools/thread/fixed.ts:78
  • +
  • Defined in src/pools/abstract-pool.ts:287
  • +
  • Defined in src/pools/thread/fixed.ts:54
  • +
  • Defined in src/pools/abstract-pool.ts:256
  • +
  • Defined in src/pools/abstract-pool.ts:249
  • +
  • Defined in src/pools/abstract-pool.ts:244
  • +
  • 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:209
  • +
  • Defined in src/pools/abstract-pool.ts:309
  • +
  • Defined in src/pools/abstract-pool.ts:453
  • +
  • Defined in src/pools/abstract-pool.ts:76
  • numberOfWorkers: number
    @@ -157,7 +157,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:75
  • opts: ClusterPoolOptions = {}
    @@ -165,7 +165,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:53
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -178,7 +178,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:51
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -187,7 +187,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:61
  • workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -195,7 +195,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:38
  • Accessors

    @@ -209,7 +209,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:186
  • +
  • Defined in src/pools/abstract-pool.ts:176
  • +
  • Defined in src/pools/cluster/fixed.ts:99
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:335
  • +
  • Defined in src/pools/cluster/fixed.ts:93
  • +
  • Defined in src/pools/abstract-pool.ts:324
  • +
  • Defined in src/pools/abstract-pool.ts:368
  • +
  • Defined in src/pools/abstract-pool.ts:430
  • +
  • Defined in src/pools/cluster/fixed.ts:88
  • +
  • Defined in src/pools/abstract-pool.ts:287
  • +
  • Defined in src/pools/cluster/fixed.ts:69
  • +
  • Defined in src/pools/abstract-pool.ts:256
  • +
  • Defined in src/pools/abstract-pool.ts:249
  • +
  • Defined in src/pools/abstract-pool.ts:244
  • +
  • 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:209
  • +
  • Defined in src/pools/cluster/fixed.ts:59
  • +
  • Defined in src/pools/abstract-pool.ts:453
  • +
  • Defined in src/pools/abstract-pool.ts:76
  • numberOfWorkers: number
    @@ -157,7 +157,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:75
  • opts: PoolOptions<ThreadWorkerWithMessageChannel>
    @@ -165,7 +165,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:77
  • promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    @@ -178,7 +178,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:51
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    @@ -187,7 +187,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:61
  • workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    @@ -195,7 +195,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:38
  • Accessors

    @@ -209,7 +209,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:186
  • +
  • Defined in src/pools/abstract-pool.ts:176
  • +
  • Defined in src/pools/thread/fixed.ts:95
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:335
  • +
  • Defined in src/pools/thread/fixed.ts:85
  • +
  • Defined in src/pools/abstract-pool.ts:324
  • +
  • Defined in src/pools/abstract-pool.ts:368
  • +
  • Defined in src/pools/abstract-pool.ts:430
  • +
  • Defined in src/pools/thread/fixed.ts:78
  • +
  • Defined in src/pools/abstract-pool.ts:287
  • +
  • Defined in src/pools/thread/fixed.ts:54
  • +
  • Defined in src/pools/abstract-pool.ts:256
  • +
  • Defined in src/pools/abstract-pool.ts:249
  • +
  • Defined in src/pools/abstract-pool.ts:244
  • +
  • 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:209
  • +
  • Defined in src/pools/abstract-pool.ts:309
  • +
  • Defined in src/pools/abstract-pool.ts:453
  • +
  • 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:146
  • +
  • Defined in src/worker/abstract-worker.ts:129
  • +
  • Defined in src/worker/abstract-worker.ts:161
  • +
  • Defined in src/worker/abstract-worker.ts:84
  • +
  • Defined in src/worker/abstract-worker.ts:171
  • +
  • Defined in src/worker/abstract-worker.ts:198
  • +
  • Defined in src/worker/thread-worker.ts:36
  • +
  • Defined in src/pools/selection-strategies/worker-choice-strategy-context.ts:24
  • @@ -95,21 +95,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
  • workerChoiceStrategyType: "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

    @@ -123,7 +123,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:95
  • +
  • Defined in src/pools/pool.ts:104
  • 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,7 +124,7 @@
    +
  • Defined in src/pools/pool.ts:110
  • workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    @@ -132,7 +132,7 @@
    +
  • Defined in src/pools/pool.ts:87
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -140,7 +140,7 @@
    +
  • Defined in src/pools/pool.ts:91
  • +
  • Defined in src/pools/pool.ts:164
  • emitter?: PoolEmitter
    @@ -86,7 +86,7 @@
    +
  • Defined in src/pools/pool.ts:143
  • execute: ((data: Data) => Promise<Response>)
    @@ -110,7 +110,7 @@

    Returns Promise<Response>

    +
  • Defined in src/pools/pool.ts:160
  • findFreeWorkerNodeKey: (() => number)
    @@ -129,7 +129,7 @@

    Returns number

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

    Returns void

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

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

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

    Pool worker nodes.

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

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

    Returns boolean

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

    Required tasks usage statistics.

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

    Returns boolean

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:73
  • +
  • Defined in src/pools/worker.ts:46
  • kill?: 1 | "SOFT" | "HARD"

    Kill code.

    +
  • Defined in src/utility-types.ts:25
  • parent?: MainWorker
    @@ -90,14 +90,14 @@

    Only for internal use.

    +
  • Defined in src/utility-types.ts:40
  • runTime?: number

    Runtime.

    +
  • Defined in src/utility-types.ts:33
  • +
  • Defined in src/pools/pool.ts:104
  • 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:110
  • workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

    The worker choice strategy to use in this pool.

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

    The worker choice strategy options.

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

    Returns void

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

    The worker handling the execution.

    +
  • Defined in src/utility-types.ts:65
  • +
  • Defined in src/pools/pool.ts:59
  • Worker tasks usage statistics.

    @@ -23,7 +23,7 @@
    • TasksUsage
    +
  • Defined in src/pools/worker.ts:54
  • @@ -47,49 +47,49 @@

    Average tasks runtime.

    +
  • Defined in src/pools/worker.ts:74
  • error: number

    Number of tasks errored.

    +
  • Defined in src/pools/worker.ts:82
  • medRunTime: number

    Median tasks runtime.

    +
  • Defined in src/pools/worker.ts:78
  • run: number

    Number of tasks executed.

    +
  • Defined in src/pools/worker.ts:58
  • runTime: number

    Tasks runtime.

    +
  • Defined in src/pools/worker.ts:66
  • runTimeHistory: CircularArray<number>

    Tasks runtime history.

    +
  • Defined in src/pools/worker.ts:70
  • running: number

    Number of tasks running.

    +
  • Defined in src/pools/worker.ts:62
  • +
  • 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