Silence typedoc warnings
[poolifier.git] / src / pools / thread / dynamic.ts
index 04125854e2f24e7bb6c1d058bb57fa953105eb35..7069f7f374907976702e944328f4e97663fd99c2 100644 (file)
@@ -1,4 +1,5 @@
-import type { PoolOptions } from '../abstract-pool'
+import type { PoolOptions } from '../pool'
+import { PoolType } from '../pool-internal'
 import type { ThreadWorkerWithMessageChannel } from './fixed'
 import { FixedThreadPool } from './fixed'
 
@@ -8,9 +9,8 @@ import { FixedThreadPool } from './fixed'
  * 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.
- *
+ * @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 [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */
@@ -24,7 +24,7 @@ export class DynamicThreadPool<
    * @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 opts Options for this dynamic thread pool.
    */
   public constructor (
     min: number,
@@ -35,8 +35,13 @@ export class DynamicThreadPool<
     super(min, filePath, opts)
   }
 
-  /** @inheritdoc */
-  public isDynamic (): boolean {
-    return true
+  /** @inheritDoc */
+  public get type (): PoolType {
+    return PoolType.DYNAMIC
+  }
+
+  /** @inheritDoc */
+  public get busy (): boolean {
+    return this.workers.length === this.max
   }
 }