refactor: remove unneeded encapsulation around tasks usage handling
[poolifier.git] / src / pools / pool-internal.ts
index 3f35ec13e25b79e67c3cb2c9084843adcbf63f99..9da6495266ab6c6e4654def94eca460b4630cb24 100644 (file)
@@ -1,9 +1,8 @@
-import EventEmitter from 'events'
 import type { IPool } from './pool'
 import type { IPoolWorker } from './pool-worker'
 
 /**
- * Pool types.
+ * Internal pool types.
  */
 export enum PoolType {
   FIXED = 'fixed',
@@ -11,7 +10,7 @@ export enum PoolType {
 }
 
 /**
- * Tasks usage statistics.
+ * Internal tasks usage statistics.
  */
 export interface TasksUsage {
   run: number
@@ -21,16 +20,21 @@ export interface TasksUsage {
 }
 
 /**
- * Internal poolifier pool emitter.
+ * Internal worker type.
+ *
+ * @typeParam Worker - Type of worker which manages this pool.
  */
-export class PoolEmitter extends EventEmitter {}
+export interface WorkerType<Worker extends IPoolWorker> {
+  worker: Worker
+  tasksUsage: TasksUsage
+}
 
 /**
  * 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.
+ * @typeParam Response - Type of response of execution.
  */
 export interface IPoolInternal<
   Worker extends IPoolWorker,
@@ -38,26 +42,9 @@ export interface IPoolInternal<
   Response = unknown
 > extends IPool<Data, Response> {
   /**
-   * List of currently available workers.
-   */
-  readonly workers: Worker[]
-
-  /**
-   * The workers tasks usage map.
-   *
-   *  `key`: The `Worker`
-   *  `value`: Worker tasks usage statistics.
-   */
-  readonly workersTasksUsage: Map<Worker, TasksUsage>
-
-  /**
-   * Emitter on which events can be listened to.
-   *
-   * Events that can currently be listened to:
-   *
-   * - `'busy'`
+   * Pool workers map.
    */
-  readonly emitter?: PoolEmitter
+  readonly workers: Map<number, WorkerType<Worker>>
 
   /**
    * Pool type.
@@ -66,11 +53,6 @@ export interface IPoolInternal<
    */
   readonly type: PoolType
 
-  /**
-   * Maximum number of workers that can be created by this pool.
-   */
-  readonly max?: number
-
   /**
    * Whether the pool is busy or not.
    *
@@ -92,29 +74,13 @@ export interface IPoolInternal<
    *
    * @returns A free worker if there is one, otherwise `false`.
    */
-  findFreeWorker(): Worker | false
-
-  /**
-   * Gets worker index.
-   *
-   * @param worker The worker.
-   * @returns The worker index.
-   */
-  getWorkerIndex(worker: Worker): number
-
-  /**
-   * Gets worker running tasks.
-   *
-   * @param worker The worker.
-   * @returns The number of tasks currently running on the worker.
-   */
-  getWorkerRunningTasks(worker: Worker): number | undefined
+  findFreeWorker: () => Worker | false
 
   /**
-   * Gets worker average tasks runtime.
+   * Gets worker tasks usage.
    *
-   * @param worker The worker.
-   * @returns The average tasks runtime on the worker.
+   * @param worker The worker.
+   * @returns The tasks usage on the worker.
    */
-  getWorkerAverageTasksRunTime(worker: Worker): number | undefined
+  getWorkerTasksUsage: (worker: Worker) => TasksUsage | undefined
 }