Refine some comments
[poolifier.git] / src / pools / cluster / dynamic.ts
index f0c3c0e40cf21cceb0e2048d1b7931417d972c96..ebff6bfe2fa2a1abbf104db0e0dee0ce2ca312c9 100644 (file)
@@ -1,3 +1,4 @@
+import { PoolType } from '../pool-internal'
 import type { ClusterPoolOptions } from './fixed'
 import { FixedClusterPool } from './fixed'
 
@@ -7,9 +8,8 @@ import { FixedClusterPool } from './fixed'
  * 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.
- *
+ * @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.
  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  * @since 2.0.0
  */
@@ -23,7 +23,7 @@ export class DynamicClusterPool<
    * @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 [opts={}] Options for this dynamic cluster pool.
    */
   public constructor (
     min: number,
@@ -34,8 +34,13 @@ export class DynamicClusterPool<
     super(min, filePath, opts)
   }
 
-  /** @inheritdoc */
-  public get dynamic (): boolean {
-    return true
+  /** @inheritDoc */
+  public get type (): PoolType {
+    return PoolType.DYNAMIC
+  }
+
+  /** @inheritDoc */
+  public get busy (): boolean {
+    return this.workers.length === this.max
   }
 }