Apply dependencies update. (#369)

[poolifier.git] / src / worker / cluster-worker.ts

diff --git a/src/worker/cluster-worker.ts b/src/worker/cluster-worker.ts
index 092dd51129089f761e06da0d8db39672396c119a..1028b9a969cc3622abd546705362ea099eb30f5c 100644 (file)
--- a/src/worker/cluster-worker.ts
+++ b/src/worker/cluster-worker.ts
@@ -5,48 +5,39 @@ import { AbstractWorker } from './abstract-worker'
 import type { WorkerOptions } from './worker-options'
 
 /**
- * An example worker that will be always alive, you just need to **extend** this class if you want a static pool.
+ * A cluster worker used by a poolifier `ClusterPool`.
  *
- * When this worker is inactive for more than 1 minute, it will send this info to the main worker,
- * if you are using DynamicClusterPool, the workers created after will be killed, the min num of worker will be guaranteed.
+ * When this worker is inactive for more than the given `maxInactiveTime`,
+ * it will send a termination request to its main worker.
  *
+ * If you use a `DynamicClusterPool` the extra workers that were created will be terminated,
+ * but the minimum number of workers will be guaranteed.
+ *
+ * @template DataType of data this worker receives from pool's execution. This can only be serializable data.
+ * @template ResponseType of response the worker sends back to the main worker. This can only be serializable data.
  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  * @since 2.0.0
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export class ClusterWorker<Data = any, Response = any> extends AbstractWorker<
-  Worker,
-  Data,
-  Response
-> {
+export class ClusterWorker<
+  Data = unknown,
+  Response = unknown
+> extends AbstractWorker<Worker, Data, Response> {
+  /**
+   * Constructs a new poolifier cluster worker.
+   *
+   * @param fn Function processed by the worker when the pool's `execution` function is invoked.
+   * @param opts Options for the worker.
+   */
   public constructor (fn: (data: Data) => Response, opts: WorkerOptions = {}) {
-    super('worker-cluster-pool:pioardi', isMaster, fn, opts)
-
-    worker.on('message', (value: MessageValue<Data>) => {
-      if (value?.data && value.id) {
-        // here you will receive messages
-        // console.log('This is the main worker ' + isMain)
-        if (this.async) {
-          this.runInAsyncScope(this.runAsync.bind(this), this, fn, value)
-        } else {
-          this.runInAsyncScope(this.run.bind(this), this, fn, value)
-        }
-      } else if (value.kill) {
-        // here is time to kill this worker, just clearing the interval
-        if (this.interval) clearInterval(this.interval)
-        this.emitDestroy()
-      }
-    })
-  }
-
-  protected getMainWorker (): Worker {
-    return worker
+    super('worker-cluster-pool:poolifier', isMaster, fn, worker, opts)
   }
 
+  /** @inheritdoc */
   protected sendToMainWorker (message: MessageValue<Response>): void {
     this.getMainWorker().send(message)
   }
 
+  /** @inheritdoc */
   protected handleError (e: Error | string): string {
     return e instanceof Error ? e.message : e
   }