Merge branch 'master' into worker-info

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

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 32adfc66ab7a7b7cd4e6dc95e7e8d9346592773c..7c6f6769212c45513453af5d3b373f2b752f4c62 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -13,21 +13,36 @@ 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
+
+/**
+ * Enumeration of worker types.
+ */
+export const WorkerTypes = Object.freeze({
+  cluster: 'cluster',
+  thread: 'thread'
+} as const)
+
+/**
+ * Worker type.
+ */
+export type WorkerType = keyof typeof WorkerTypes
 
 /**
  * Pool events emitter.
@@ -49,6 +64,25 @@ export const PoolEvents = Object.freeze({
  */
 export type PoolEvent = keyof typeof PoolEvents
 
+/**
+ * Pool information.
+ */
+export interface PoolInfo {
+  type: PoolType
+  worker: WorkerType
+  minSize: number
+  maxSize: number
+  utilization: number
+  workerNodes: number
+  idleWorkerNodes: number
+  busyWorkerNodes: number
+  executedTasks: number
+  executingTasks: number
+  queuedTasks: number
+  maxQueuedTasks: number
+  failedTasks: number
+}
+
 /**
  * Worker tasks queue options.
  */
@@ -119,8 +153,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,
@@ -128,15 +162,9 @@ export interface IPool<
   Response = unknown
 > {
   /**
-   * Pool type.
-   *
-   * If it is `'dynamic'`, it provides the `max` property.
-   */
-  readonly type: PoolType
-  /**
-   * Pool maximum size.
+   * Pool information.
    */
-  readonly size: number
+  readonly info: PoolInfo
   /**
    * Pool worker nodes.
    */
@@ -155,13 +183,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>
   /**
-   * Shutdowns every current worker in this pool.
+   * Terminate every current worker in this pool.
    */
   destroy: () => Promise<void>
   /**