src/pools/thread/dynamic.ts

   1 import type { PoolOptions } from '../abstract-pool'
   2 import { PoolType } from '../pool-internal'
   3 import type { ThreadWorkerWithMessageChannel } from './fixed'
   4 import { FixedThreadPool } from './fixed'
   5
   6 /**
   7  * A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
   8  *
   9  * This thread pool creates new threads when the others are busy, up to the maximum number of threads.
  10  * When the maximum number of threads is reached, an event is emitted. If you want to listen to this event, use the pool's `emitter`.
  11  *
  12  * @template Data Type of data sent to the worker. This can only be serializable data.
  13  * @template Response Type of response of execution. This can only be serializable data.
  14  *
  15  * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
  16  * @since 0.0.1
  17  */
  18 export class DynamicThreadPool<
  19   Data = unknown,
  20   Response = unknown
  21 > extends FixedThreadPool<Data, Response> {
  22   /**
  23    * Constructs a new poolifier dynamic thread pool.
  24    *
  25    * @param min Minimum number of threads which are always active.
  26    * @param max Maximum number of threads that can be created by this pool.
  27    * @param filePath Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
  28    * @param opts Options for this dynamic thread pool. Default: `{}`
  29    */
  30   public constructor (
  31     min: number,
  32     public readonly max: number,
  33     filePath: string,
  34     opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
  35   ) {
  36     super(min, filePath, opts)
  37   }
  38
  39   /** @inheritdoc */
  40   public get type (): PoolType {
  41     return PoolType.DYNAMIC
  42   }
  43
  44   /** @inheritdoc */
  45   public get busy (): boolean {
  46     return this.workers.length === this.max
  47   }
  48 }