chore: generate documentation

[poolifier.git] / src / pools / pool-internal.ts

diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts
index 9da6495266ab6c6e4654def94eca460b4630cb24..806107ec74ea29402408abaf3cf95a8f0325581c 100644 (file)
--- a/src/pools/pool-internal.ts
+++ b/src/pools/pool-internal.ts
@@ -17,6 +17,7 @@ export interface TasksUsage {
   running: number
   runTime: number
   avgRunTime: number
+  error: number
 }
 
 /**
@@ -42,9 +43,9 @@ export interface IPoolInternal<
   Response = unknown
 > extends IPool<Data, Response> {
   /**
-   * Pool workers map.
+   * Pool worker type items array.
    */
-  readonly workers: Map<number, WorkerType<Worker>>
+  readonly workers: Array<WorkerType<Worker>>
 
   /**
    * Pool type.
@@ -54,33 +55,27 @@ export interface IPoolInternal<
   readonly type: PoolType
 
   /**
-   * Whether the pool is busy or not.
+   * Whether the pool is full or not.
    *
-   * The pool busyness boolean status.
+   * The pool filling boolean status.
    */
-  readonly busy: boolean
+  readonly full: boolean
 
   /**
-   * Number of tasks currently concurrently running.
+   * Whether the pool is busy or not.
+   *
+   * The pool busyness boolean status.
    */
-  readonly numberOfRunningTasks: number
+  readonly busy: boolean
 
   /**
-   * Finds a free worker based on the number of tasks the worker has applied.
+   * Finds a free worker key based on the number of tasks the worker has applied.
    *
-   * If a worker is found with `0` running tasks, it is detected as free and returned.
+   * If a worker is found with `0` running tasks, it is detected as free and its key is returned.
    *
    * If no free worker is found, `false` is returned.
    *
-   * @returns A free worker if there is one, otherwise `false`.
-   */
-  findFreeWorker: () => Worker | false
-
-  /**
-   * Gets worker tasks usage.
-   *
-   * @param worker - The worker.
-   * @returns The tasks usage on the worker.
+   * @returns A worker key if there is one, `-1` otherwise.
    */
-  getWorkerTasksUsage: (worker: Worker) => TasksUsage | undefined
+  findFreeWorkerKey: () => number
 }