Version 2.3.1
[poolifier.git] / src / pools / pool-internal.ts
index 71120110f75bfb48c6e005876b8b7715e53f53fb..6e2850a892d8d63f024e09d6db40e23b43129c06 100644 (file)
@@ -1,6 +1,6 @@
 import EventEmitter from 'events'
-import type { AbstractPoolWorker } from './abstract-pool-worker'
 import type { IPool } from './pool'
+import type { IPoolWorker } from './pool-worker'
 
 /**
  * Pool types.
@@ -10,6 +10,16 @@ export enum PoolType {
   DYNAMIC = 'dynamic'
 }
 
+/**
+ * Tasks usage statistics.
+ */
+export interface TasksUsage {
+  run: number
+  running: number
+  runTime: number
+  avgRunTime: number
+}
+
 /**
  * Internal poolifier pool emitter.
  */
@@ -23,7 +33,7 @@ export class PoolEmitter extends EventEmitter {}
  * @template Response Type of response of execution.
  */
 export interface IPoolInternal<
-  Worker extends AbstractPoolWorker,
+  Worker extends IPoolWorker,
   Data = unknown,
   Response = unknown
 > extends IPool<Data, Response> {
@@ -33,12 +43,12 @@ export interface IPoolInternal<
   readonly workers: Worker[]
 
   /**
-   * The tasks map.
+   * The workers tasks usage map.
    *
-   * - `key`: The `Worker`
-   * - `value`: Number of tasks currently in progress on the worker.
+   *  `key`: The `Worker`
+   *  `value`: Worker tasks usage statistics.
    */
-  readonly tasks: Map<Worker, number>
+  readonly workersTasksUsage: Map<Worker, TasksUsage>
 
   /**
    * Emitter on which events can be listened to.
@@ -99,4 +109,12 @@ export interface IPoolInternal<
    * @returns The number of tasks currently running on the worker.
    */
   getWorkerRunningTasks(worker: Worker): number | undefined
+
+  /**
+   * Get worker average tasks runtime.
+   *
+   * @param worker The worker.
+   * @returns The average tasks runtime on the worker.
+   */
+  getWorkerAverageTasksRunTime(worker: Worker): number | undefined
 }