docs: enhance error message

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

diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts
index bd75cf4f04aa766020cca4c56b33706482e131cc..b245e360df704ee1e7fde5ce4e114da060cc70fd 100644 (file)
--- a/src/pools/pool-internal.ts
+++ b/src/pools/pool-internal.ts
@@ -1,51 +1,38 @@
 import type { IPool } from './pool'
-import type { IPoolWorker } from './pool-worker'
+import type { IWorker, WorkerNode } from './worker'
 
 /**
  * Internal pool types.
+ *
+ * @enum
  */
 export enum PoolType {
+  /**
+   * Fixed pool type.
+   */
   FIXED = 'fixed',
+  /**
+   * Dynamic pool type.
+   */
   DYNAMIC = 'dynamic'
 }
 
-/**
- * Internal tasks usage statistics.
- */
-export interface TasksUsage {
-  run: number
-  running: number
-  runTime: number
-  avgRunTime: number
-  error: number
-}
-
-/**
- * Internal worker type.
- *
- * @typeParam Worker - Type of worker which manages this pool.
- */
-export interface WorkerType<Worker extends IPoolWorker> {
-  worker: Worker
-  tasksUsage: TasksUsage
-}
-
 /**
  * Internal contract definition for a poolifier pool.
  *
  * @typeParam Worker - Type of worker which manages this pool.
- * @typeParam Data - Type of data sent to the worker.
- * @typeParam Response - Type of response of execution.
+ * @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.
  */
 export interface IPoolInternal<
-  Worker extends IPoolWorker,
+  Worker extends IWorker,
   Data = unknown,
   Response = unknown
 > extends IPool<Data, Response> {
   /**
-   * Pool workers item array.
+   * Pool worker nodes.
    */
-  readonly workers: Array<WorkerType<Worker>>
+  readonly workerNodes: Array<WorkerNode<Worker, Data>>
 
   /**
    * Pool type.
@@ -55,33 +42,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.
-   *
-   * If a worker is found with `0` running tasks, it is detected as free and returned.
+   * Finds a free worker node key based on the number of tasks the worker has applied.
    *
-   * If no free worker is found, `false` is returned.
+   * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned.
    *
-   * @returns A free worker if there is one, otherwise `false`.
-   */
-  findFreeWorker: () => Worker | false
-
-  /**
-   * Gets worker tasks usage.
+   * If no free worker is found, `-1` is returned.
    *
-   * @param worker - The worker.
-   * @returns The tasks usage on the worker.
+   * @returns A worker node key if there is one, `-1` otherwise.
    */
-  getWorkerTasksUsage: (worker: Worker) => TasksUsage | undefined
+  findFreeWorkerNodeKey: () => number
 }