docs: sync worker choice context constructor comment

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

diff --git a/src/pools/cluster/fixed.ts b/src/pools/cluster/fixed.ts
index 7ad425a399d1f08c3c97afbaab9b12272571a580..78de7073b615fc10936091aca0cd203165efaac8 100644 (file)
--- a/src/pools/cluster/fixed.ts
+++ b/src/pools/cluster/fixed.ts
@@ -1,5 +1,5 @@
-import type { Worker } from 'cluster'
-import cluster from 'cluster'
+import type { ClusterSettings, Worker } from 'node:cluster'
+import cluster from 'node:cluster'
 import type { MessageValue } from '../../utility-types'
 import { AbstractPool } from '../abstract-pool'
 import type { PoolOptions } from '../pool'
@@ -16,6 +16,12 @@ export interface ClusterPoolOptions extends PoolOptions<Worker> {
    */
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   env?: any
+  /**
+   * Cluster settings.
+   *
+   * @see https://nodejs.org/api/cluster.html#cluster_cluster_settings
+   */
+  settings?: ClusterSettings
 }
 
 /**
@@ -25,8 +31,8 @@ export interface ClusterPoolOptions extends PoolOptions<Worker> {
  *
  * This pool selects the workers in a round robin fashion.
  *
- * @template DataType of data sent to the worker. This can only be serializable data.
- * @template ResponseType of response of execution. This can only be serializable data.
+ * @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
  */
@@ -37,9 +43,9 @@ export class FixedClusterPool<
   /**
    * 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.
+   * @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.
    */
   public constructor (
     numberOfWorkers: number,
@@ -51,9 +57,7 @@ export class FixedClusterPool<
 
   /** @inheritDoc */
   protected setupHook (): void {
-    cluster.setupPrimary({
-      exec: this.filePath
-    })
+    cluster.setupPrimary({ ...this.opts.settings, exec: this.filePath })
   }
 
   /** @inheritDoc */
@@ -73,7 +77,7 @@ export class FixedClusterPool<
   }
 
   /** @inheritDoc */
-  public registerWorkerMessageListener<Message extends Data | Response> (
+  public registerWorkerMessageListener<Message extends Data | Response>(
     worker: Worker,
     listener: (message: MessageValue<Message>) => void
   ): void {
@@ -87,7 +91,7 @@ export class FixedClusterPool<
 
   /** @inheritDoc */
   protected afterWorkerSetup (worker: Worker): void {
-    // Listen worker messages.
+    // Listen to worker messages.
     this.registerWorkerMessageListener(worker, super.workerListener())
   }
 
@@ -96,8 +100,13 @@ export class FixedClusterPool<
     return PoolType.FIXED
   }
 
+  /** @inheritDoc */
+  public get full (): boolean {
+    return this.workers.length === this.numberOfWorkers
+  }
+
   /** @inheritDoc */
   public get busy (): boolean {
-    return this.internalGetBusyStatus()
+    return this.internalBusy()
   }
 }