chore: v3.0.5
[poolifier.git] / src / pools / cluster / dynamic.ts
CommitLineData
6b27d407 1import { type PoolType, PoolTypes } from '../pool'
bde6b5d7 2import { checkDynamicPoolSize } from '../utils'
6b27d407 3import { type ClusterPoolOptions, FixedClusterPool } from './fixed'
f045358d 4
4ade5f1f 5/**
729c563d 6 * A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
4ade5f1f 7 *
729c563d 8 * This cluster pool creates new workers when the others are busy, up to the maximum number of workers.
9cd39dd4 9 * When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's `emitter`.
729c563d 10 *
e102732c
JB
11 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
12 * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
325f50bc
S
13 * @author [Christopher Quadflieg](https://github.com/Shinigami92)
14 * @since 2.0.0
4ade5f1f 15 */
325f50bc 16export class DynamicClusterPool<
deb85c12
JB
17 Data = unknown,
18 Response = unknown
325f50bc 19> extends FixedClusterPool<Data, Response> {
4ade5f1f 20 /**
729c563d
S
21 * Constructs a new poolifier dynamic cluster pool.
22 *
38e795c1
JB
23 * @param min - Minimum number of workers which are always active.
24 * @param max - Maximum number of workers that can be created by this pool.
25 * @param filePath - Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
26 * @param opts - Options for this dynamic cluster pool.
4ade5f1f
S
27 */
28 public constructor (
c97c7edb 29 min: number,
b4213b7f 30 protected readonly max: number,
31b90205 31 filePath: string,
ed6dd37f 32 opts: ClusterPoolOptions = {}
4ade5f1f 33 ) {
31b90205 34 super(min, filePath, opts)
bde6b5d7 35 checkDynamicPoolSize(this.numberOfWorkers, this.max)
4ade5f1f
S
36 }
37
afc003b2 38 /** @inheritDoc */
8881ae32 39 protected get type (): PoolType {
6b27d407 40 return PoolTypes.dynamic
7c0ba920
JB
41 }
42
afc003b2 43 /** @inheritDoc */
c319c66b 44 protected get busy (): boolean {
0527b6db 45 return this.full && this.internalBusy()
c2ade475 46 }
4ade5f1f 47}