docs: enhance documentation

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

diff --git a/src/pools/thread/dynamic.ts b/src/pools/thread/dynamic.ts
index b4fd46c1c401d5bde0fd990fe35a05e1e4129bb4..7bf477dd837c0ce3e30cb65ad308c32ca0774f48 100644 (file)
--- a/src/pools/thread/dynamic.ts
+++ b/src/pools/thread/dynamic.ts
@@ -1,4 +1,5 @@
-import type { PoolOptions } from '../abstract-pool'
+import type { PoolOptions } from '../pool'
+import { PoolType } from '../pool'
 import type { ThreadWorkerWithMessageChannel } from './fixed'
 import { FixedThreadPool } from './fixed'
 
@@ -6,11 +7,10 @@ import { FixedThreadPool } from './fixed'
  * A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
  *
  * This thread pool creates new threads when the others are busy, up to the maximum number of threads.
- * When the maximum number of threads 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 threads 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 [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */
@@ -21,10 +21,10 @@ export class DynamicThreadPool<
   /**
    * Constructs a new poolifier dynamic thread pool.
    *
-   * @param min Minimum number of threads which are always active.
-   * @param max Maximum number of threads that can be created by this pool.
-   * @param filePath Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
-   * @param opts Options for this dynamic thread pool. Default: `{}`
+   * @param min - Minimum number of threads which are always active.
+   * @param max - Maximum number of threads that can be created by this pool.
+   * @param filePath - Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
+   * @param opts - Options for this dynamic thread pool.
    */
   public constructor (
     min: number,
@@ -35,8 +35,18 @@ export class DynamicThreadPool<
     super(min, filePath, opts)
   }
 
-  /** @inheritdoc */
-  public get dynamic (): boolean {
-    return true
+  /** @inheritDoc */
+  public get type (): PoolType {
+    return PoolType.DYNAMIC
+  }
+
+  /** @inheritDoc */
+  protected get full (): boolean {
+    return this.workerNodes.length === this.max
+  }
+
+  /** @inheritDoc */
+  protected get busy (): boolean {
+    return this.full && this.internalBusy()
   }
 }