chore: generate documentation

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

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index f4a1791504f16964c94f378be5a35b066e0cc0e9..89559d2c9a1bf0e6694709d3908a0263af0c448e 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -1,4 +1,4 @@
-import EventEmitter from 'node:events'
+import EventEmitterAsyncResource from 'node:events'
 import type {
   ErrorHandler,
   ExitHandler,
@@ -32,14 +32,15 @@ export enum PoolType {
 /**
  * Pool events emitter.
  */
-export class PoolEmitter extends EventEmitter {}
+export class PoolEmitter extends EventEmitterAsyncResource {}
 
 /**
  * Enumeration of pool events.
  */
 export const PoolEvents = Object.freeze({
   full: 'full',
-  busy: 'busy'
+  busy: 'busy',
+  error: 'error'
 } as const)
 
 /**
@@ -91,6 +92,10 @@ export interface PoolOptions<Worker extends IWorker> {
    * The worker choice strategy options.
    */
   workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
+  /**
+   * Restart worker on error.
+   */
+  restartWorkerOnError?: boolean
   /**
    * Pool events emission.
    *
@@ -127,6 +132,10 @@ export interface IPool<
    * If it is `'dynamic'`, it provides the `max` property.
    */
   readonly type: PoolType
+  /**
+   * Pool maximum size.
+   */
+  readonly size: number
   /**
    * Pool worker nodes.
    */
@@ -138,25 +147,17 @@ 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.
    */
   readonly emitter?: PoolEmitter
   /**
-   * Finds a free worker node key based on the number of tasks the worker has applied.
-   *
-   * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned.
-   *
-   * If no free worker is found, `-1` is returned.
-   *
-   * @returns A worker node key if there is one, `-1` otherwise.
-   */
-  findFreeWorkerNodeKey: () => number
-  /**
-   * Executes the function specified in the constructor with the task data input parameter.
+   * Executes the specified function in the worker constructor with the task data input parameter.
    *
-   * @param data - The task input data for the specified function. This can only be serializable data.
-   * @returns Promise that will be resolved when the task is successfully completed.
+   * @param data - The task input data for the specified worker function. This can only be serializable 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) => Promise<Response>
+  execute: (data?: Data, name?: string) => Promise<Response>
   /**
    * Shutdowns every current worker in this pool.
    */