build: disable esModuleInterop from TS configuration
[poolifier.git] / src / pools / pool.ts
index 257b0d64b0844d664ba00763b1dcde79c4711ee7..bb28535b0e732c7eafee9fa353f38166999862e5 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,12 +68,18 @@ export type PoolEvent = keyof typeof PoolEvents
  * Pool information.
  */
 export interface PoolInfo {
+  version: string
   type: PoolType
   worker: WorkerType
   minSize: number
   maxSize: 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
@@ -91,7 +97,7 @@ export interface TasksQueueOptions {
    *
    * @defaultValue 1
    */
-  concurrency?: number
+  readonly concurrency?: number
 }
 
 /**
@@ -152,8 +158,8 @@ export interface PoolOptions<Worker extends IWorker> {
  * Contract definition for a poolifier pool.
  *
  * @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 execution response. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
  */
 export interface IPool<
   Worker extends IWorker,
@@ -182,13 +188,13 @@ export interface IPool<
   /**
    * Executes the specified function in the worker constructor with the task data input parameter.
    *
-   * @param data - The task input data for the specified worker function. This can only be serializable data.
+   * @param data - The task input data for the specified worker function. This can only be structured-cloneable data.
    * @param name - The name of the worker function to execute. If not specified, the default worker function will be executed.
    * @returns Promise that will be fulfilled when the task is completed.
    */
   execute: (data?: Data, name?: string) => Promise<Response>
   /**
-   * Terminate every current worker in this pool.
+   * Terminates every current worker in this pool.
    */
   destroy: () => Promise<void>
   /**