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