feat: expose pool information

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

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 32adfc66ab7a7b7cd4e6dc95e7e8d9346592773c..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.
@@ -49,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.
  */
@@ -134,9 +151,9 @@ export interface IPool<
    */
   readonly type: PoolType
   /**
-   * Pool maximum size.
+   * Pool information.
    */
-  readonly size: number
+  readonly info: PoolInfo
   /**
    * Pool worker nodes.
    */