src/pools/cluster/dynamic.ts

   1 import { PoolType } from '../pool-internal'
   2 import type { ClusterPoolOptions } from './fixed'
   3 import { FixedClusterPool } from './fixed'
   4
   5 /**
   6  * A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
   7  *
   8  * This cluster pool creates new workers when the others are busy, up to the maximum number of workers.
   9  * When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's `emitter`.
  10  *
  11  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
  12  * @typeParam Response - Type of response of execution. This can only be serializable data.
  13  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  14  * @since 2.0.0
  15  */
  16 export class DynamicClusterPool<
  17   Data = unknown,
  18   Response = unknown
  19 > extends FixedClusterPool<Data, Response> {
  20   /**
  21    * Constructs a new poolifier dynamic cluster pool.
  22    *
  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.
  27    */
  28   public constructor (
  29     min: number,
  30     protected readonly max: number,
  31     filePath: string,
  32     opts: ClusterPoolOptions = {}
  33   ) {
  34     super(min, filePath, opts)
  35   }
  36
  37   /** {@inheritDoc} */
  38   public get type (): PoolType {
  39     return PoolType.DYNAMIC
  40   }
  41
  42   /** {@inheritDoc} */
  43   public get busy (): boolean {
  44     return this.workers.length === this.max
  45   }
  46 }