From: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 2 Jul 2023 21:57:01 +0000 (+0000) Subject: chore: generate documentation X-Git-Tag: v2.6.7~7^2~3 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=2a6631992868d900762f62e4c228dce4e4ee549a;p=poolifier.git chore: generate documentation --- diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index c7e8d6be..6e4b7c70 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -49,7 +49,7 @@ +
  • Defined in src/pools/abstract-pool.ts:49
  • @@ -174,7 +174,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    @@ -192,7 +192,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:58
  • filePath: string
    @@ -200,7 +200,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:96
  • numberOfWorkers: number
    @@ -208,7 +208,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:95
  • opts: PoolOptions<Worker>
    @@ -216,7 +216,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:97
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -229,7 +229,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:68
  • startTimestamp: number
    @@ -237,7 +237,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:85
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -245,7 +245,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:76
  • workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -254,7 +254,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:55
  • Accessors

    @@ -268,7 +268,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:450
  • +
  • Defined in src/pools/abstract-pool.ts:441
  • +
  • Defined in src/pools/abstract-pool.ts:250
  • +
  • Defined in src/pools/abstract-pool.ts:347
  • +
  • Defined in src/pools/abstract-pool.ts:342
  • +
  • Defined in src/pools/abstract-pool.ts:303
  • +
  • Defined in src/pools/abstract-pool.ts:332
  • +
  • Defined in src/pools/abstract-pool.ts:312
  • +
  • Defined in src/pools/abstract-pool.ts:337
  • Methods

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:555
  • +
  • Defined in src/pools/abstract-pool.ts:747
  • +
  • Defined in src/pools/abstract-pool.ts:539
  • Returns TasksQueueOptions

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

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:197
  • +
  • Defined in src/pools/abstract-pool.ts:689
  • +
  • Defined in src/pools/abstract-pool.ts:790
  • +
  • Defined in src/pools/abstract-pool.ts:757
  • +
  • Defined in src/pools/abstract-pool.ts:739
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:974
  • +
  • Defined in src/pools/abstract-pool.ts:500
  • +
  • Defined in src/pools/abstract-pool.ts:515
  • +
  • Defined in src/pools/abstract-pool.ts:406
  • Returns number

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

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

    +
  • Defined in src/pools/abstract-pool.ts:986
  • +
  • Defined in src/pools/abstract-pool.ts:998
  • +
  • Defined in src/pools/abstract-pool.ts:355
  • +
  • Defined in src/pools/abstract-pool.ts:920
  • +
  • Defined in src/pools/abstract-pool.ts:366
  • Returns WorkerUsage

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

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

    +
  • Defined in src/pools/abstract-pool.ts:827
  • +
  • Defined in src/pools/abstract-pool.ts:457
  • +
  • Defined in src/pools/abstract-pool.ts:530
  • +
  • Defined in src/pools/abstract-pool.ts:899
  • +
  • Defined in src/pools/abstract-pool.ts:727
  • +
  • Defined in src/pools/abstract-pool.ts:957
  • +
  • Defined in src/pools/abstract-pool.ts:716
  • +
  • Defined in src/pools/abstract-pool.ts:418
  • +
  • Defined in src/pools/abstract-pool.ts:373
  • +
  • Defined in src/pools/abstract-pool.ts:395
  • +
  • Defined in src/pools/abstract-pool.ts:886
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1004
  • +
  • Defined in src/pools/abstract-pool.ts:523
  • +
  • Defined in src/pools/abstract-pool.ts:706
  • Returns number

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:606
  • +
  • Defined in src/pools/abstract-pool.ts:815
  • +
  • Defined in src/worker/abstract-worker.ts:42
  • isMain: boolean
    @@ -166,7 +166,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:70
  • lastTaskTimestamp: number
    @@ -174,7 +174,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:50
  • mainWorker: MainWorker
    @@ -182,7 +182,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:74
  • opts: WorkerOptions = ...
    @@ -190,7 +190,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:75
  • statistics: WorkerStatistics
    @@ -198,7 +198,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:54
  • taskFunctions: Map<string, WorkerFunction<Data, Response>>
    @@ -206,7 +206,7 @@
    +
  • Defined in src/worker/abstract-worker.ts:46
  • Methods

    @@ -227,7 +227,7 @@
  • Returns TaskPerformance

  • +
  • Defined in src/worker/abstract-worker.ts:303
  • +
  • Defined in src/worker/abstract-worker.ts:196
  • +
  • Defined in src/worker/abstract-worker.ts:326
  • +
  • Defined in src/worker/abstract-worker.ts:113
  • Returns void

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

    +
  • Defined in src/worker/abstract-worker.ts:311
  • +
  • Defined in src/worker/abstract-worker.ts:177
  • +
  • Defined in src/worker/abstract-worker.ts:294
  • +
  • Defined in src/worker/abstract-worker.ts:211
  • +
  • Defined in src/worker/abstract-worker.ts:153
  • +
  • Defined in src/worker/abstract-worker.ts:256
  • +
  • Defined in src/worker/abstract-worker.ts:221
  • +
  • Defined in src/worker/abstract-worker.ts:189
  • +
  • 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
  • +
  • Defined in src/worker/cluster-worker.ts:21
  • @@ -120,7 +120,7 @@ but the minimum number of workers will be guaranteed.

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

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

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

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

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

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

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

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

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

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

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

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

    +
  • Defined in src/worker/abstract-worker.ts:196
  • +
  • Defined in src/worker/abstract-worker.ts:177
  • +
  • Defined in src/worker/abstract-worker.ts:211
  • +
  • Defined in src/worker/abstract-worker.ts:153
  • +
  • Defined in src/worker/abstract-worker.ts:256
  • +
  • Defined in src/worker/abstract-worker.ts:221
  • +
  • Defined in src/worker/cluster-worker.ts:52
  • +
  • Defined in src/pools/cluster/dynamic.ts:15
  • @@ -142,7 +142,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

    @@ -160,7 +160,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:58
  • filePath: string
    @@ -169,7 +169,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:96
  • max: number
    @@ -177,7 +177,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
    @@ -186,7 +186,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:95
  • opts: ClusterPoolOptions = {}
    @@ -195,7 +195,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/fixed.ts:52
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -209,7 +209,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:68
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -218,7 +218,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:76
  • workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -227,7 +227,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/abstract-pool.ts:55
  • Accessors

    @@ -242,7 +242,7 @@ When the maximum number of workers is reached and workers are busy, an event is
    +
  • Defined in src/pools/cluster/dynamic.ts:47
  • +
  • Defined in src/pools/abstract-pool.ts:441
  • +
  • Defined in src/pools/abstract-pool.ts:250
  • +
  • Defined in src/pools/cluster/dynamic.ts:42
  • +
  • Defined in src/pools/cluster/fixed.ts:97
  • +
  • Defined in src/pools/abstract-pool.ts:303
  • +
  • Defined in src/pools/cluster/dynamic.ts:37
  • +
  • Defined in src/pools/abstract-pool.ts:312
  • +
  • Defined in src/pools/cluster/fixed.ts:92
  • Methods

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

    +
  • Defined in src/pools/abstract-pool.ts:555
  • +
  • Defined in src/pools/abstract-pool.ts:747
  • +
  • Defined in src/pools/abstract-pool.ts:539
  • +
  • Defined in src/pools/abstract-pool.ts:790
  • +
  • Defined in src/pools/abstract-pool.ts:757
  • +
  • Defined in src/pools/cluster/fixed.ts:82
  • +
  • Defined in src/pools/abstract-pool.ts:500
  • +
  • Defined in src/pools/cluster/fixed.ts:68
  • +
  • Defined in src/pools/abstract-pool.ts:406
  • +
  • Defined in src/pools/abstract-pool.ts:466
  • +
  • Defined in src/pools/abstract-pool.ts:457
  • +
  • Defined in src/pools/cluster/fixed.ts:63
  • +
  • Defined in src/pools/cluster/fixed.ts:77
  • +
  • Defined in src/pools/abstract-pool.ts:418
  • +
  • Defined in src/pools/abstract-pool.ts:373
  • +
  • Defined in src/pools/abstract-pool.ts:395
  • +
  • Defined in src/pools/cluster/fixed.ts:58
  • +
  • Defined in src/pools/abstract-pool.ts:815
  • +
  • Defined in src/pools/abstract-pool.ts:815
  • +
  • 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 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:149
  • 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:115
  • exitHandler?: ExitHandler<Worker>
    @@ -98,7 +98,7 @@
    +
  • Defined in src/pools/pool.ts:123
  • messageHandler?: MessageHandler<Worker>
    @@ -107,7 +107,7 @@
    +
  • Defined in src/pools/pool.ts:111
  • onlineHandler?: OnlineHandler<Worker>
    @@ -116,7 +116,7 @@
    +
  • Defined in src/pools/pool.ts:119
  • restartWorkerOnError?: boolean
    @@ -125,7 +125,7 @@
    +
  • Defined in src/pools/pool.ts:137
  • 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:153
  • 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:129
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -164,7 +164,7 @@
    +
  • Defined in src/pools/pool.ts:133
  • +
  • Defined in src/pools/pool.ts:186
  • enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -125,7 +125,7 @@

    Returns void

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

    Returns void

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

    Returns void

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

    Returns void

    +
  • Defined in src/pools/pool.ts:214
  • workerNodes: WorkerNode<Worker, Data>[]
    @@ -248,7 +248,7 @@
    +
  • Defined in src/pools/pool.ts:175
  • +
  • Defined in src/pools/worker.ts:176
  • once: ((event, handler) => void)
    @@ -147,12 +147,12 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:186
  • threadId?: number
    +
  • Defined in src/pools/worker.ts:169
  • +
  • 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:87
  • statistics?: WorkerStatistics
    @@ -110,7 +110,7 @@
    +
  • Defined in src/utility-types.ts:83
  • taskError?: TaskError<ErrorData>
    @@ -118,7 +118,7 @@
    +
  • Defined in src/utility-types.ts:75
  • taskPerformance?: TaskPerformance
    @@ -126,7 +126,7 @@
    +
  • Defined in src/utility-types.ts:79
  • timestamp?: number
    @@ -135,7 +135,7 @@
    +
  • Defined in src/pools/worker.ts:51
  • workerId?: number
    @@ -143,7 +143,7 @@
    +
  • Defined in src/utility-types.ts:67
  • +
  • Defined in src/pools/pool.ts:80
  • maxQueuedTasks: number
    +
  • Defined in src/pools/pool.ts:86
  • maxSize: number
    +
  • Defined in src/pools/pool.ts:74
  • minSize: number
    +
  • Defined in src/pools/pool.ts:73
  • queuedTasks: number
    +
  • Defined in src/pools/pool.ts:85
  • type: "fixed" | "dynamic"
    +
  • Defined in src/pools/pool.ts:71
  • utilization: number
    @@ -111,12 +111,12 @@
    +
  • Defined in src/pools/pool.ts:76
  • worker: "cluster" | "thread"
    +
  • Defined in src/pools/pool.ts:72
  • workerNodes: number
    @@ -124,7 +124,7 @@
    +
  • Defined in src/pools/pool.ts:78
  • +
  • Defined in src/pools/pool.ts:149
  • errorHandler?: ErrorHandler<Worker>
    @@ -83,7 +83,7 @@
    +
  • Defined in src/pools/pool.ts:115
  • exitHandler?: ExitHandler<Worker>
    @@ -91,7 +91,7 @@
    +
  • Defined in src/pools/pool.ts:123
  • messageHandler?: MessageHandler<Worker>
    @@ -99,7 +99,7 @@
    +
  • Defined in src/pools/pool.ts:111
  • onlineHandler?: OnlineHandler<Worker>
    @@ -107,7 +107,7 @@
    +
  • Defined in src/pools/pool.ts:119
  • restartWorkerOnError?: boolean
    @@ -115,7 +115,7 @@
    +
  • Defined in src/pools/pool.ts:137
  • tasksQueueOptions?: TasksQueueOptions
    @@ -123,7 +123,7 @@
    +
  • Defined in src/pools/pool.ts:153
  • 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:129
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -141,7 +141,7 @@
    +
  • Defined in src/pools/pool.ts:133
  • +
  • Defined in src/utility-types.ts:104
  • worker: Worker
    @@ -100,7 +100,7 @@
    +
  • Defined in src/utility-types.ts:112
  • +
  • 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:18
  • workerId: number
    @@ -69,7 +69,7 @@
    +
  • Defined in src/utility-types.ts:14
  • Task performance.

    @@ -24,7 +24,7 @@
    +
  • Defined in src/utility-types.ts:30
  • @@ -45,7 +45,7 @@
    +
  • Defined in src/utility-types.ts:42
  • runTime?: number
    @@ -53,7 +53,7 @@
    +
  • Defined in src/utility-types.ts:38
  • timestamp: number
    @@ -61,7 +61,7 @@
    +
  • Defined in src/utility-types.ts:34
  • +
  • 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:99
  • +
  • Defined in src/pools/pool.ts:149
  • errorHandler?: ErrorHandler<Worker>
    @@ -78,7 +78,7 @@
    +
  • Defined in src/pools/pool.ts:115
  • exitHandler?: ExitHandler<Worker>
    @@ -87,7 +87,7 @@
    +
  • Defined in src/pools/pool.ts:123
  • messageHandler?: MessageHandler<Worker>
    @@ -96,7 +96,7 @@
    +
  • Defined in src/pools/pool.ts:111
  • onlineHandler?: OnlineHandler<Worker>
    @@ -105,7 +105,7 @@
    +
  • Defined in src/pools/pool.ts:119
  • restartWorkerOnError?: boolean
    @@ -114,7 +114,7 @@
    +
  • Defined in src/pools/pool.ts:137
  • tasksQueueOptions?: TasksQueueOptions
    @@ -123,7 +123,7 @@
    +
  • Defined in src/pools/pool.ts:153
  • 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:129
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -143,7 +143,7 @@
    +
  • Defined in src/pools/pool.ts:133
  • 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
  • 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
  • +
  • Defined in src/pools/worker.ts:134
  • +
  • Defined in src/pools/worker.ts:212
  • @@ -75,7 +75,7 @@
    +
  • Defined in src/pools/worker.ts:208
  • worker: Worker
    @@ -83,7 +83,7 @@
    +
  • Defined in src/pools/worker.ts:200
  • +
  • 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
  • Performance statistics computation.

    @@ -24,7 +24,7 @@
    +
  • Defined in src/utility-types.ts:50
  • @@ -41,12 +41,12 @@
    elu: boolean
    +
  • Defined in src/utility-types.ts:52
  • runTime: boolean
    +
  • Defined in src/utility-types.ts:51
  • +
  • Defined in src/pools/worker.ts:150
  • @@ -62,7 +62,7 @@
    +
  • Defined in src/pools/worker.ts:146
  • waitTime: MeasurementStatistics
    @@ -70,7 +70,7 @@
    +
  • Defined in src/pools/worker.ts:154
  • +
  • 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