refactor: freeze empty function type

[poolifier.git] / src / pools / cluster / dynamic.ts

diff --git a/src/pools/cluster/dynamic.ts b/src/pools/cluster/dynamic.ts
index 25940ad84340f43f3e7b0abf5cec7ddf3edbc8d4..513a73c5d7804cfa2e109a5d9cf6c01f4c060945 100644 (file)
--- a/src/pools/cluster/dynamic.ts
+++ b/src/pools/cluster/dynamic.ts
@@ -1,63 +1,47 @@
-import type { Worker } from 'cluster'
-import type { JSONValue, MessageValue } from '../../utility-types'
+import { EMPTY_OBJECT_LITERAL } from '../../utils'
+import { PoolType } from '../pool-internal'
 import type { ClusterPoolOptions } from './fixed'
 import { FixedClusterPool } from './fixed'
 
 /**
- * A cluster pool with a min/max number of workers, is possible to execute tasks in sync or async mode as you prefer.
+ * A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
  *
- * This cluster pool will create new workers when the other ones are busy, until the max number of workers,
- * when the max number of workers is reached, an event will be emitted, if you want to listen this event use the emitter method.
+ * This cluster pool creates new workers when the others are busy, up to the maximum number of workers.
+ * 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`.
  *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of response of execution. This can only be serializable data.
  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  * @since 2.0.0
  */
 export class DynamicClusterPool<
-  Data extends JSONValue = JSONValue,
-  Response extends JSONValue = JSONValue
+  Data = unknown,
+  Response = unknown
 > extends FixedClusterPool<Data, Response> {
   /**
-   * @param min Min number of workers that will be always active
-   * @param max Max number of workers that will be active
-   * @param filename A file path with implementation of `ClusterWorker` class, relative path is fine.
-   * @param opts An object with possible options for example `errorHandler`, `onlineHandler`. Default: `{ maxTasks: 1000 }`
+   * Constructs a new poolifier dynamic cluster pool.
+   *
+   * @param min - Minimum number of workers which are always active.
+   * @param max - Maximum number of workers that can be created by this pool.
+   * @param filePath - Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
+   * @param opts - Options for this dynamic cluster pool.
    */
   public constructor (
     min: number,
-    public readonly max: number,
-    filename: string,
-    opts: ClusterPoolOptions = { maxTasks: 1000 }
+    protected readonly max: number,
+    filePath: string,
+    opts: ClusterPoolOptions = EMPTY_OBJECT_LITERAL
   ) {
-    super(min, filename, opts)
+    super(min, filePath, opts)
   }
 
-  protected chooseWorker (): Worker {
-    let worker: Worker | undefined
-    for (const entry of this.tasks) {
-      if (entry[1] === 0) {
-        worker = entry[0]
-        break
-      }
-    }
+  /** {@inheritDoc} */
+  public get type (): PoolType {
+    return PoolType.DYNAMIC
+  }
 
-    if (worker) {
-      // a worker is free, use it
-      return worker
-    } else {
-      if (this.workers.length === this.max) {
-        this.emitter.emit('FullPool')
-        return super.chooseWorker()
-      }
-      // all workers are busy create a new worker
-      const worker = this.internalNewWorker()
-      worker.on('message', (message: MessageValue<Data>) => {
-        if (message.kill) {
-          this.sendToWorker(worker, { kill: 1 })
-          void this.destroyWorker(worker)
-          this.removeWorker(worker)
-        }
-      })
-      return worker
-    }
+  /** {@inheritDoc} */
+  public get busy (): boolean {
+    return this.workers.length === this.max
   }
 }