docs: refine FIXME comment
[poolifier.git] / src / pools / pool.ts
index 7c6f6769212c45513453af5d3b373f2b752f4c62..15654803d64f2a3e1d6924c5120d47c4f56a2283 100644 (file)
@@ -1,4 +1,4 @@
-import EventEmitterAsyncResource from 'node:events'
+import { EventEmitter } from 'node:events'
 import type {
   ErrorHandler,
   ExitHandler,
@@ -47,7 +47,7 @@ export type WorkerType = keyof typeof WorkerTypes
 /**
  * Pool events emitter.
  */
-export class PoolEmitter extends EventEmitterAsyncResource {}
+export class PoolEmitter extends EventEmitter {}
 
 /**
  * Enumeration of pool events.
@@ -68,19 +68,32 @@ export type PoolEvent = keyof typeof PoolEvents
  * Pool information.
  */
 export interface PoolInfo {
+  version: string
   type: PoolType
   worker: WorkerType
   minSize: number
   maxSize: number
-  utilization: number
+  /** Pool utilization ratio. */
+  utilization?: number
+  /** Pool total worker nodes */
   workerNodes: number
+  /** Pool idle worker nodes */
   idleWorkerNodes: number
+  /** Pool busy worker nodes */
   busyWorkerNodes: number
   executedTasks: number
   executingTasks: number
   queuedTasks: number
   maxQueuedTasks: number
   failedTasks: number
+  runTime?: {
+    minimum: number
+    maximum: number
+  }
+  waitTime?: {
+    minimum: number
+    maximum: number
+  }
 }
 
 /**
@@ -92,7 +105,7 @@ export interface TasksQueueOptions {
    *
    * @defaultValue 1
    */
-  concurrency?: number
+  readonly concurrency?: number
 }
 
 /**
@@ -189,7 +202,7 @@ export interface IPool<
    */
   execute: (data?: Data, name?: string) => Promise<Response>
   /**
-   * Terminate every current worker in this pool.
+   * Terminates every current worker in this pool.
    */
   destroy: () => Promise<void>
   /**