docs: enhance documentation

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

diff --git a/src/pools/cluster/dynamic.ts b/src/pools/cluster/dynamic.ts
index 33497b0314ef1e46eb3bd129557f31b5e5f4cc17..78c63aca64d8da1e879c723bd0fd064f46de83ee 100644 (file)
--- a/src/pools/cluster/dynamic.ts
+++ b/src/pools/cluster/dynamic.ts
@@ -1,4 +1,4 @@
-import { PoolType } from '../pool-internal'
+import { PoolType } from '../pool'
 import type { ClusterPoolOptions } from './fixed'
 import { FixedClusterPool } from './fixed'
 
@@ -6,11 +6,10 @@ import { FixedClusterPool } from './fixed'
  * A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
  *
  * 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`.
- *
- * @template Data Type of data sent to the worker. This can only be serializable data.
- * @template Response Type of response of execution. This can only be serializable data.
+ * When the maximum number of workers is reached and workers are busy, 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
  */
@@ -21,10 +20,10 @@ export class DynamicClusterPool<
   /**
    * 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. Default: `{}`
+   * @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,
@@ -35,13 +34,18 @@ export class DynamicClusterPool<
     super(min, filePath, opts)
   }
 
-  /** @inheritdoc */
+  /** @inheritDoc */
   public get type (): PoolType {
     return PoolType.DYNAMIC
   }
 
-  /** @inheritdoc */
-  public get busy (): boolean {
-    return this.workers.length === this.max
+  /** @inheritDoc */
+  protected get full (): boolean {
+    return this.workerNodes.length === this.max
+  }
+
+  /** @inheritDoc */
+  protected get busy (): boolean {
+    return this.full && this.internalBusy()
   }
 }