X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=f1da5356a2e5310d799b6e595a898a3aad783600;hb=7cd8af0033b35def46016a78ea9be1ee516480bf;hp=2ce311f710e0d7a809b5b219cd7309c9354d15cf;hpb=78cea37e264d5ca527bc42eb056f3b9579a2b2c4;p=poolifier.git

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 2ce311f7..f1da5356 100644
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -1,4 +1,4 @@
-import EventEmitter from 'events'
+import EventEmitter from 'node:events'
 import type {
   ErrorHandler,
   ExitHandler,
@@ -12,6 +12,19 @@ import type { WorkerChoiceStrategy } from './selection-strategies/selection-stra
  */
 export class PoolEmitter extends EventEmitter {}
 
+/**
+ * Enumeration of pool events.
+ */
+export const PoolEvents = Object.freeze({
+  full: 'full',
+  busy: 'busy'
+} as const)
+
+/**
+ * Pool event.
+ */
+export type PoolEvent = keyof typeof PoolEvents
+
 /**
  * Options for a poolifier pool.
  */
@@ -39,7 +52,7 @@ export interface PoolOptions<Worker> {
   /**
    * Pool events emission.
    *
-   * @default true
+   * @defaultValue true
    */
   enableEvents?: boolean
 }
@@ -47,8 +60,8 @@ export interface PoolOptions<Worker> {
 /**
  * Contract definition for a poolifier pool.
  *
- * @template Data Type of data sent to the worker. This can only be serializable data.
- * @template Response Type of response of execution. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of response of execution. This can only be serializable data.
  */
 export interface IPool<Data = unknown, Response = unknown> {
   /**
@@ -56,13 +69,14 @@ export interface IPool<Data = unknown, Response = unknown> {
    *
    * Events that can currently be listened to:
    *
-   * - `'busy'`
+   * - `'full'`: Emitted when the pool is dynamic and full.
+   * - `'busy'`: Emitted when the pool is busy.
    */
   readonly emitter?: PoolEmitter
   /**
    * Performs the task specified in the constructor with the data parameter.
    *
-   * @param data The input for the specified task. This can only be serializable data.
+   * @param data - The input for the specified task. This can only be serializable data.
    * @returns Promise that will be resolved when the task is successfully completed.
    */
   execute: (data: Data) => Promise<Response>
@@ -73,7 +87,7 @@ export interface IPool<Data = unknown, Response = unknown> {
   /**
    * Sets the worker choice strategy in this pool.
    *
-   * @param workerChoiceStrategy The worker choice strategy.
+   * @param workerChoiceStrategy - The worker choice strategy.
    */
   setWorkerChoiceStrategy: (workerChoiceStrategy: WorkerChoiceStrategy) => void
 }