From a6d9dccfaf39e185c896747260d668fcb683a8ed Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 27 Jun 2023 15:49:10 +0000 Subject: [PATCH] chore: generate documentation --- docs/classes/AbstractPool.html | 124 +++++++++--------- docs/classes/AbstractWorker.html | 58 ++++---- docs/classes/CircularArray.html | 22 ++-- docs/classes/ClusterWorker.html | 46 +++---- docs/classes/DynamicClusterPool.html | 70 +++++----- docs/classes/DynamicThreadPool.html | 70 +++++----- docs/classes/FixedClusterPool.html | 68 +++++----- docs/classes/FixedThreadPool.html | 68 +++++----- docs/classes/PoolEmitter.html | 54 ++++---- docs/classes/Queue.html | 20 +-- docs/classes/ThreadWorker.html | 46 +++---- docs/classes/WorkerChoiceStrategyContext.html | 22 ++-- docs/interfaces/ClusterPoolOptions.html | 26 ++-- ...tLoopUtilizationMeasurementStatistics.html | 8 +- docs/interfaces/IPool.html | 20 +-- docs/interfaces/IWorker.html | 6 +- docs/interfaces/IWorkerChoiceStrategy.html | 16 +-- docs/interfaces/MeasurementOptions.html | 4 +- docs/interfaces/MeasurementStatistics.html | 10 +- .../MeasurementStatisticsRequirements.html | 8 +- docs/interfaces/MessageValue.html | 18 +-- docs/interfaces/PoolInfo.html | 26 ++-- docs/interfaces/PoolOptions.html | 22 ++-- docs/interfaces/PromiseResponseWrapper.html | 8 +- docs/interfaces/StrategyPolicy.html | 4 +- docs/interfaces/Task.html | 10 +- docs/interfaces/TaskError.html | 6 +- docs/interfaces/TaskPerformance.html | 8 +- docs/interfaces/TaskStatistics.html | 12 +- .../TaskStatisticsRequirements.html | 8 +- docs/interfaces/TasksQueueOptions.html | 4 +- docs/interfaces/ThreadPoolOptions.html | 24 ++-- .../WorkerChoiceStrategyOptions.html | 12 +- docs/interfaces/WorkerNode.html | 8 +- docs/interfaces/WorkerOptions.html | 8 +- docs/interfaces/WorkerStatistics.html | 6 +- docs/interfaces/WorkerUsage.html | 10 +- docs/types/ErrorHandler.html | 2 +- docs/types/ExitHandler.html | 2 +- docs/types/KillBehavior.html | 2 +- docs/types/Measurement.html | 2 +- docs/types/MessageHandler.html | 2 +- docs/types/OnlineHandler.html | 2 +- docs/types/PoolEvent.html | 2 +- docs/types/PoolType.html | 2 +- docs/types/TaskFunctions.html | 2 +- docs/types/WorkerAsyncFunction.html | 2 +- docs/types/WorkerChoiceStrategy.html | 2 +- docs/types/WorkerFunction.html | 2 +- docs/types/WorkerSyncFunction.html | 2 +- docs/types/WorkerType.html | 2 +- docs/variables/KillBehaviors.html | 2 +- docs/variables/Measurements.html | 2 +- docs/variables/PoolEvents.html | 2 +- docs/variables/PoolTypes.html | 2 +- docs/variables/WorkerChoiceStrategies.html | 2 +- docs/variables/WorkerTypes.html | 2 +- 57 files changed, 500 insertions(+), 500 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 685d002d..bfa752b0 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -49,7 +49,7 @@ +
  • Defined in src/pools/abstract-pool.ts:46
  • @@ -167,7 +167,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    @@ -185,7 +185,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:55
  • filePath: string
    @@ -193,7 +193,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:88
  • numberOfWorkers: number
    @@ -201,7 +201,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:87
  • opts: PoolOptions<Worker>
    @@ -209,7 +209,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:89
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -222,7 +222,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -230,7 +230,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:73
  • workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -239,7 +239,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:52
  • Accessors

    @@ -253,7 +253,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:401
  • +
  • Defined in src/pools/abstract-pool.ts:392
  • +
  • Defined in src/pools/abstract-pool.ts:240
  • +
  • Defined in src/pools/abstract-pool.ts:309
  • +
  • Defined in src/pools/abstract-pool.ts:304
  • +
  • Defined in src/pools/abstract-pool.ts:294
  • +
  • Defined in src/pools/abstract-pool.ts:299
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:506
  • +
  • Defined in src/pools/abstract-pool.ts:699
  • +
  • Defined in src/pools/abstract-pool.ts:490
  • Returns TasksQueueOptions

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

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:187
  • +
  • Defined in src/pools/abstract-pool.ts:641
  • +
  • Defined in src/pools/abstract-pool.ts:742
  • +
  • Defined in src/pools/abstract-pool.ts:709
  • +
  • Defined in src/pools/abstract-pool.ts:691
  • Returns undefined | Task<Data>

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:900
  • +
  • Defined in src/pools/abstract-pool.ts:912
  • +
  • Defined in src/pools/abstract-pool.ts:317
  • Returns WorkerUsage

    +
  • Defined in src/pools/abstract-pool.ts:930
  • +
  • Defined in src/pools/abstract-pool.ts:408
  • +
  • Defined in src/pools/abstract-pool.ts:481
  • +
  • Defined in src/pools/abstract-pool.ts:831
  • +
  • Defined in src/pools/abstract-pool.ts:679
  • +
  • Defined in src/pools/abstract-pool.ts:871
  • +
  • Defined in src/pools/abstract-pool.ts:668
  • +
  • Defined in src/pools/abstract-pool.ts:369
  • +
  • Defined in src/pools/abstract-pool.ts:324
  • +
  • Defined in src/pools/abstract-pool.ts:346
  • +
  • Defined in src/pools/abstract-pool.ts:818
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:918
  • +
  • Defined in src/pools/abstract-pool.ts:474
  • +
  • Defined in src/pools/abstract-pool.ts:658
  • Returns number

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:558
  • +
  • Defined in src/pools/abstract-pool.ts:769
  • +
  • Defined in src/worker/abstract-worker.ts:66
  • lastTaskTimestamp: number
    @@ -165,15 +165,15 @@
    +
  • Defined in src/worker/abstract-worker.ts:46
  • - +
    mainWorker: MainWorker

    Reference to main worker.

    +
  • Defined in src/worker/abstract-worker.ts:70
  • opts: WorkerOptions = ...
    @@ -181,7 +181,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:71
  • statistics: WorkerStatistics
    @@ -189,7 +189,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:50
  • taskFunctions: Map<string, WorkerFunction<Data, Response>>
    @@ -197,7 +197,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:42
  • Methods

    @@ -210,7 +210,7 @@
    +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:306
  • +
  • Defined in src/worker/abstract-worker.ts:295
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:283
  • +
  • Defined in src/worker/abstract-worker.ts:192
  • +
  • Defined in src/worker/abstract-worker.ts:318
  • +
  • Defined in src/worker/abstract-worker.ts:109
  • Returns void

    +
  • Defined in src/worker/abstract-worker.ts:97
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:302
  • Returns TaskPerformance

    +
  • Defined in src/worker/abstract-worker.ts:303
  • +
  • Defined in src/worker/abstract-worker.ts:173
  • +
  • Defined in src/worker/abstract-worker.ts:286
  • +
  • Defined in src/worker/abstract-worker.ts:207
  • +
  • Defined in src/worker/abstract-worker.ts:149
  • +
  • Defined in src/worker/abstract-worker.ts:250
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:294
  • +
  • Defined in src/worker/abstract-worker.ts:217
  • +
  • Defined in src/worker/abstract-worker.ts:185
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:311
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:277
  • +
  • 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
  • +
  • Defined in src/worker/cluster-worker.ts:21
  • @@ -116,7 +116,7 @@ but the minimum number of workers will be guaranteed.

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

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

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

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

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

    Reference to main worker.

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

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

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

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

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

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:306
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:283
  • +
  • Defined in src/worker/abstract-worker.ts:192
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:302
  • +
  • Defined in src/worker/abstract-worker.ts:173
  • +
  • Defined in src/worker/cluster-worker.ts:52
  • +
  • Defined in src/worker/abstract-worker.ts:149
  • +
  • Defined in src/worker/abstract-worker.ts:250
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:294
  • +
  • Defined in src/worker/abstract-worker.ts:217
  • +
  • Defined in src/worker/cluster-worker.ts:47
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:311
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:277
  • +
  • Defined in src/pools/abstract-pool.ts:769
  • +
  • Defined in src/pools/abstract-pool.ts:769
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:333
  • defaultMaxListeners: number
    @@ -138,7 +138,7 @@ Its name property is set to 'MaxListenersExceededWarning&
    +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:370
  • errorMonitor: typeof errorMonitor
    @@ -151,7 +151,7 @@ regular 'error' listener is installed.

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:319
  • Methods

    @@ -185,7 +185,7 @@ regular 'error' listener is installed.

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:390
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:652
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:715
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:567
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:661
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:580
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:540
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:422
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:452
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:679
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:695
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:611
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:551
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:535
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:561
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:296
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:268
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:250
  • @@ -772,7 +772,7 @@ special handling:

    Returns Promise<any[]>

  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:190
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/events.d.ts:311
  • +
  • Defined in src/queue.ts:12
  • Methods

    @@ -111,7 +111,7 @@

    Returns void

    +
  • Defined in src/queue.ts:68
  • +
  • Defined in src/queue.ts:40
  • +
  • Defined in src/queue.ts:26
  • +
  • Defined in src/queue.ts:58
  • +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:294
  • +
  • Defined in src/worker/abstract-worker.ts:217
  • +
  • Defined in src/worker/thread-worker.ts:47
    • @@ -439,7 +439,7 @@ then restore the original execution context.

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:311
    • @@ -475,7 +475,7 @@ then restore the original execution context.

    +
  • Defined in node_modules/.pnpm/@types+node@20.3.2/node_modules/@types/node/async_hooks.d.ts:277
  • +
  • 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
  • +
  • Defined in src/pools/pool.ts:144
  • 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:21
  • errorHandler?: ErrorHandler<Worker>
    @@ -89,7 +89,7 @@
    +
  • Defined in src/pools/pool.ts:110
  • exitHandler?: ExitHandler<Worker>
    @@ -98,7 +98,7 @@
    +
  • Defined in src/pools/pool.ts:118
  • messageHandler?: MessageHandler<Worker>
    @@ -107,7 +107,7 @@
    +
  • Defined in src/pools/pool.ts:106
  • onlineHandler?: OnlineHandler<Worker>
    @@ -116,7 +116,7 @@
    +
  • Defined in src/pools/pool.ts:114
  • restartWorkerOnError?: boolean
    @@ -125,7 +125,7 @@
    +
  • Defined in src/pools/pool.ts:132
  • settings?: ClusterSettings
    @@ -135,7 +135,7 @@

    See

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

    +
  • Defined in src/pools/cluster/fixed.ts:27
  • tasksQueueOptions?: TasksQueueOptions
    @@ -144,7 +144,7 @@
    +
  • Defined in src/pools/pool.ts:148
  • 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:124
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/pool.ts:128
  • +
  • Defined in src/pools/pool.ts:181
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -125,7 +125,7 @@

    Returns void

    +
  • Defined in src/pools/pool.ts:218
  • execute: ((data?, name?) => Promise<Response>)
    @@ -155,7 +155,7 @@
    +
  • Defined in src/pools/pool.ts:189
  • info: PoolInfo
    @@ -163,7 +163,7 @@
    +
  • Defined in src/pools/pool.ts:166
  • setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -187,7 +187,7 @@

    Returns void

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

    Returns void

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

    Returns void

    +
  • Defined in src/pools/pool.ts:209
  • workerNodes: WorkerNode<Worker, Data>[]
    @@ -248,7 +248,7 @@
    +
  • Defined in src/pools/pool.ts:170
  • +
  • Defined in src/pools/worker.ts:165
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:191
  • reset: (() => boolean)
    @@ -100,7 +100,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:172
  • setOptions: ((opts) => void)
    @@ -124,7 +124,7 @@

    Returns void

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:197
  • strategyPolicy: StrategyPolicy
    @@ -132,7 +132,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:162
  • taskStatisticsRequirements: TaskStatisticsRequirements
    @@ -140,7 +140,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:166
  • update: ((workerNodeKey) => boolean)
    @@ -162,7 +162,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:178
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:65
  • +
  • Defined in src/pools/worker.ts:71
  • history: CircularArray<number>
    @@ -62,7 +62,7 @@
    +
  • Defined in src/pools/worker.ts:79
  • median: number
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:75
  • +
  • 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
  • +
  • Defined in src/utility-types.ts:71
  • taskError?: TaskError<ErrorData>
    @@ -108,7 +108,7 @@
    +
  • Defined in src/utility-types.ts:63
  • taskPerformance?: TaskPerformance
    @@ -116,7 +116,7 @@
    +
  • Defined in src/utility-types.ts:67
  • timestamp?: number
    @@ -125,7 +125,7 @@
    +
  • Defined in src/pools/worker.ts:51
  • +
  • Defined in src/pools/pool.ts:144
  • errorHandler?: ErrorHandler<Worker>
    @@ -83,7 +83,7 @@
    +
  • Defined in src/pools/pool.ts:110
  • exitHandler?: ExitHandler<Worker>
    @@ -91,7 +91,7 @@
    +
  • Defined in src/pools/pool.ts:118
  • messageHandler?: MessageHandler<Worker>
    @@ -99,7 +99,7 @@
    +
  • Defined in src/pools/pool.ts:106
  • onlineHandler?: OnlineHandler<Worker>
    @@ -107,7 +107,7 @@
    +
  • Defined in src/pools/pool.ts:114
  • restartWorkerOnError?: boolean
    @@ -115,7 +115,7 @@
    +
  • Defined in src/pools/pool.ts:132
  • tasksQueueOptions?: TasksQueueOptions
    @@ -123,7 +123,7 @@
    +
  • Defined in src/pools/pool.ts:148
  • 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:124
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -141,7 +141,7 @@
    +
  • Defined in src/pools/pool.ts:128
  • +
  • Defined in src/utility-types.ts:88
  • worker: Worker
    @@ -100,7 +100,7 @@
    +
  • Defined in src/utility-types.ts:96
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:152
  • +
  • Defined in src/pools/worker.ts:55
  • name?: string
    @@ -72,7 +72,7 @@
    +
  • Defined in src/pools/worker.ts:43
  • timestamp?: number
    @@ -80,7 +80,7 @@
    +
  • Defined in src/pools/worker.ts:51
  • +
  • Defined in src/utility-types.ts:14
  • +
  • Defined in src/utility-types.ts:32
  • timestamp: number
    @@ -61,7 +61,7 @@
    +
  • Defined in src/utility-types.ts:28
  • +
  • Defined in src/pools/worker.ts:106
  • failed: number
    @@ -63,7 +63,7 @@
    +
  • Defined in src/pools/worker.ts:118
  • maxQueued: number
    @@ -71,7 +71,7 @@
    +
  • Defined in src/pools/worker.ts:114
  • queued: number
    @@ -79,7 +79,7 @@
    +
  • Defined in src/pools/worker.ts:110
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:132
  • @@ -61,7 +61,7 @@
    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:136
  • +
  • Defined in src/pools/pool.ts:94
  • +
  • Defined in src/pools/pool.ts:144
  • errorHandler?: ErrorHandler<Worker>
    @@ -78,7 +78,7 @@
    +
  • Defined in src/pools/pool.ts:110
  • exitHandler?: ExitHandler<Worker>
    @@ -87,7 +87,7 @@
    +
  • Defined in src/pools/pool.ts:118
  • messageHandler?: MessageHandler<Worker>
    @@ -96,7 +96,7 @@
    +
  • Defined in src/pools/pool.ts:106
  • onlineHandler?: OnlineHandler<Worker>
    @@ -105,7 +105,7 @@
    +
  • Defined in src/pools/pool.ts:114
  • restartWorkerOnError?: boolean
    @@ -114,7 +114,7 @@
    +
  • Defined in src/pools/pool.ts:132
  • tasksQueueOptions?: TasksQueueOptions
    @@ -123,7 +123,7 @@
    +
  • Defined in src/pools/pool.ts:148
  • 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:124
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -143,7 +143,7 @@
    +
  • Defined in src/pools/pool.ts:128
  • workerOptions?: WorkerOptions
    @@ -153,7 +153,7 @@

    See

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

    +
  • Defined in src/pools/thread/fixed.ts:26
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:75
  • @@ -67,7 +67,7 @@

    Default Value

    { median: false }

    +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:81
  • @@ -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
  • +
  • Defined in src/pools/worker.ts:179
  • workerUsage: WorkerUsage
    @@ -74,7 +74,7 @@
    +
  • Defined in src/pools/worker.ts:183
  • +
  • Defined in src/worker/worker-options.ts:69
  • 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:51
  • +
  • Defined in src/pools/worker.ts:134
  • @@ -62,7 +62,7 @@
    +
  • Defined in src/pools/worker.ts:130
  • @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:138
  • +
  • Defined in src/pools/worker.ts:15
  • +
  • Defined in src/pools/worker.ts:28
  • +
  • Defined in src/worker/worker-options.ts:18
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:56
  • +
  • Defined in src/pools/worker.ts:7
  • +
  • Defined in src/pools/worker.ts:23
  • +
  • Defined in src/pools/pool.ts:65
  • +
  • Defined in src/pools/pool.ts:32
  • +
  • Defined in src/worker/worker-functions.ts:18
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:42
  • +
  • Defined in src/worker/worker-functions.ts:7
  • +
  • Defined in src/pools/pool.ts:45
  • +
  • Defined in src/worker/worker-options.ts:4
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:47
  • +
  • Defined in src/pools/pool.ts:55
  • +
  • Defined in src/pools/pool.ts:18
  • +
  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
  • +
  • Defined in src/pools/pool.ts:37