X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fcluster%2Ffixed.ts;h=b2724426a02111108b33debcaa3c116fe9e2b0c5;hb=4c35177b63cac8a87aa6de389e1232e94c59b8c9;hp=65f6ce54c738e1b857a7c1d49f68811ca57f5697;hpb=f2fdaa86fd9e6f3a5dc0b3146c065e3a7bfb44e0;p=poolifier.git

diff --git a/src/pools/cluster/fixed.ts b/src/pools/cluster/fixed.ts
index 65f6ce54..b2724426 100644
--- a/src/pools/cluster/fixed.ts
+++ b/src/pools/cluster/fixed.ts
@@ -3,6 +3,9 @@ import type { JSONValue, MessageValue } from '../../utility-types'
 import type { PoolOptions } from '../abstract-pool'
 import { AbstractPool } from '../abstract-pool'
 
+/**
+ * Options for a poolifier cluster pool.
+ */
 export interface ClusterPoolOptions extends PoolOptions<Worker> {
   /**
    * Key/value pairs to add to worker process environment.
@@ -14,9 +17,14 @@ export interface ClusterPoolOptions extends PoolOptions<Worker> {
 }
 
 /**
- * A cluster pool with a static number of workers, is possible to execute tasks in sync or async mode as you prefer.
+ * A cluster pool with a fixed number of workers.
+ *
+ * It is possible to perform tasks in sync or asynchronous mode as you prefer.
  *
- * This pool will select the worker in a round robin fashion.
+ * This pool selects the workers in a round robin fashion.
+ *
+ * @template Data Type of data sent to the worker.
+ * @template Response Type of response of execution.
  *
  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  * @since 2.0.0
@@ -26,16 +34,18 @@ export class FixedClusterPool<
   Response extends JSONValue = JSONValue
 > extends AbstractPool<Worker, Data, Response> {
   /**
-   * @param numWorkers Number of workers for this pool.
-   * @param filePath 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 fixed cluster pool.
+   *
+   * @param numberOfWorkers Number of workers for this pool.
+   * @param filePath Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
+   * @param opts Options for this fixed cluster pool. Default: `{ maxTasks: 1000 }`
    */
   public constructor (
-    numWorkers: number,
+    numberOfWorkers: number,
     filePath: string,
     public readonly opts: ClusterPoolOptions = { maxTasks: 1000 }
   ) {
-    super(numWorkers, filePath, opts)
+    super(numberOfWorkers, filePath, opts)
   }
 
   protected setupHook (): void {
@@ -50,32 +60,31 @@ export class FixedClusterPool<
 
   protected destroyWorker (worker: Worker): void {
     worker.kill()
-    // FIXME: The tests are currently failing, so these must be changed first
   }
 
   protected sendToWorker (worker: Worker, message: MessageValue<Data>): void {
     worker.send(message)
   }
 
-  protected registerWorkerMessageListener (
-    port: Worker,
-    listener: (message: MessageValue<Response>) => void
+  protected registerWorkerMessageListener<Message extends Data | Response> (
+    worker: Worker,
+    listener: (message: MessageValue<Message>) => void
   ): void {
-    port.on('message', listener)
+    worker.on('message', listener)
   }
 
-  protected unregisterWorkerMessageListener (
-    port: Worker,
-    listener: (message: MessageValue<Response>) => void
+  protected unregisterWorkerMessageListener<Message extends Data | Response> (
+    worker: Worker,
+    listener: (message: MessageValue<Message>) => void
   ): void {
-    port.removeListener('message', listener)
+    worker.removeListener('message', listener)
   }
 
-  protected newWorker (): Worker {
+  protected createWorker (): Worker {
     return fork(this.opts.env)
   }
 
-  protected afterNewWorkerPushed (worker: Worker): void {
+  protected afterWorkerSetup (worker: Worker): void {
     // we will attach a listener for every task,
     // when task is completed the listener will be removed but to avoid warnings we are increasing the max listeners size
     worker.setMaxListeners(this.opts.maxTasks ?? 1000)