chore: v2.5.2

[poolifier.git] / src / pools / pool.ts

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 89559d2c9a1bf0e6694709d3908a0263af0c448e..0013bf5dc20a27a9b84b63645233d2e636c9df49 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -13,21 +13,23 @@ import type {
 } from './selection-strategies/selection-strategies-types'
 
 /**
- * Pool types.
- *
- * @enum
- * @internal
+ * Enumeration of pool types.
  */
-export enum PoolType {
+export const PoolTypes = Object.freeze({
   /**
    * Fixed pool type.
    */
-  FIXED = 'fixed',
+  fixed: 'fixed',
   /**
    * Dynamic pool type.
    */
-  DYNAMIC = 'dynamic'
-}
+  dynamic: 'dynamic'
+} as const)
+
+/**
+ * Pool type.
+ */
+export type PoolType = keyof typeof PoolTypes
 
 /**
  * Pool events emitter.
@@ -40,7 +42,8 @@ export class PoolEmitter extends EventEmitterAsyncResource {}
 export const PoolEvents = Object.freeze({
   full: 'full',
   busy: 'busy',
-  error: 'error'
+  error: 'error',
+  taskError: 'taskError'
 } as const)
 
 /**
@@ -48,6 +51,21 @@ export const PoolEvents = Object.freeze({
  */
 export type PoolEvent = keyof typeof PoolEvents
 
+/**
+ * Pool information.
+ */
+export interface PoolInfo {
+  type: PoolType
+  minSize: number
+  maxSize: number
+  workerNodes: number
+  idleWorkerNodes: number
+  busyWorkerNodes: number
+  runningTasks: number
+  queuedTasks: number
+  maxQueuedTasks: number
+}
+
 /**
  * Worker tasks queue options.
  */
@@ -133,9 +151,9 @@ export interface IPool<
    */
   readonly type: PoolType
   /**
-   * Pool maximum size.
+   * Pool information.
    */
-  readonly size: number
+  readonly info: PoolInfo
   /**
    * Pool worker nodes.
    */
@@ -147,7 +165,8 @@ export interface IPool<
    *
    * - `'full'`: Emitted when the pool is dynamic and full.
    * - `'busy'`: Emitted when the pool is busy.
-   * - `'error'`: Emitted when an error occurs.
+   * - `'error'`: Emitted when an uncaught error occurs.
+   * - `'taskError'`: Emitted when an error occurs while executing a task.
    */
   readonly emitter?: PoolEmitter
   /**