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 f5f1d1908a14d60f2e26f9d6baa75c627468e96b..b245e360df704ee1e7fde5ce4e114da060cc70fd 100644 (file)
--- a/src/pools/pool-internal.ts
+++ b/src/pools/pool-internal.ts
@@ -1,55 +1,38 @@
-import EventEmitter from 'events'
-import type { AbstractPoolWorker } from './abstract-pool-worker'
 import type { IPool } from './pool'
+import type { IWorker, WorkerNode } from './worker'
 
 /**
- * Pool types.
+ * Internal pool types.
+ *
+ * @enum
  */
 export enum PoolType {
+  /**
+   * Fixed pool type.
+   */
   FIXED = 'fixed',
+  /**
+   * Dynamic pool type.
+   */
   DYNAMIC = 'dynamic'
 }
 
-/**
- * Tasks usage statistics.
- */
-export interface TasksUsage {
-  run: number
-  running: number
-  runTime: number
-  avgRunTime: number
-}
-
-/**
- * Internal poolifier pool emitter.
- */
-export class PoolEmitter extends EventEmitter {}
-
 /**
  * Internal contract definition for a poolifier pool.
  *
- * @template Worker Type of worker which manages this pool.
- * @template Data Type of data sent to the worker.
- * @template Response Type of response of execution.
+ * @typeParam Worker - Type of worker which manages this pool.
+ * @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 AbstractPoolWorker,
+  Worker extends IWorker,
   Data = unknown,
   Response = unknown
 > extends IPool<Data, Response> {
   /**
-   * List of currently available workers.
-   */
-  readonly workers: Worker[]
-
-  /**
-   * Emitter on which events can be listened to.
-   *
-   * Events that can currently be listened to:
-   *
-   * - `'busy'`
+   * Pool worker nodes.
    */
-  readonly emitter?: PoolEmitter
+  readonly workerNodes: Array<WorkerNode<Worker, Data>>
 
   /**
    * Pool type.
@@ -59,9 +42,11 @@ export interface IPoolInternal<
   readonly type: PoolType
 
   /**
-   * Maximum number of workers that can be created by this pool.
+   * Whether the pool is full or not.
+   *
+   * The pool filling boolean status.
    */
-  readonly max?: number
+  readonly full: boolean
 
   /**
    * Whether the pool is busy or not.
@@ -71,42 +56,13 @@ export interface IPoolInternal<
   readonly busy: boolean
 
   /**
-   * Number of tasks currently concurrently running.
-   */
-  readonly numberOfRunningTasks: number
-
-  /**
-   * Find 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.
-   *
-   * If no free worker is found, `false` is returned.
-   *
-   * @returns A free worker if there is one, otherwise `false`.
-   */
-  findFreeWorker(): Worker | false
-
-  /**
-   * Get worker index.
+   * Finds a free worker node key based on the number of tasks the worker has applied.
    *
-   * @param worker The worker.
-   * @returns The worker index.
-   */
-  getWorkerIndex(worker: Worker): number
-
-  /**
-   * Get worker running tasks.
+   * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned.
    *
-   * @param worker The worker.
-   * @returns The number of tasks currently running on the worker.
-   */
-  getWorkerRunningTasks(worker: Worker): number | undefined
-
-  /**
-   * Get worker average tasks run time.
+   * If no free worker is found, `-1` is returned.
    *
-   * @param worker The worker.
-   * @returns The average tasks run time on the worker.
+   * @returns A worker node key if there is one, `-1` otherwise.
    */
-  getWorkerAverageTasksRunTime(worker: Worker): number | undefined
+  findFreeWorkerNodeKey: () => number
 }