X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=f1da5356a2e5310d799b6e595a898a3aad783600;hb=9eae7f2bf8939eaa61474e358835c1b2f13a754c;hp=6f677da8ba64d695e5b4b82f904f4b21ef1c7208;hpb=675bb8097982bce5bbe64e6332340373aa4aed3f;p=poolifier.git

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 6f677da8..f1da5356 100644
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -1,3 +1,4 @@
+import EventEmitter from 'node:events'
 import type {
   ErrorHandler,
   ExitHandler,
@@ -6,6 +7,24 @@ import type {
 } from './pool-worker'
 import type { WorkerChoiceStrategy } from './selection-strategies/selection-strategies-types'
 
+/**
+ * Pool events emitter.
+ */
+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.
  */
@@ -27,13 +46,13 @@ export interface PoolOptions<Worker> {
    */
   exitHandler?: ExitHandler<Worker>
   /**
-   * The work choice strategy to use in this pool.
+   * The worker choice strategy to use in this pool.
    */
   workerChoiceStrategy?: WorkerChoiceStrategy
   /**
    * Pool events emission.
    *
-   * @default true
+   * @defaultValue true
    */
   enableEvents?: boolean
 }
@@ -41,25 +60,34 @@ 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> {
   /**
-   * Perform the task specified in the constructor with the data parameter.
+   * Emitter on which events can be listened to.
+   *
+   * Events that can currently be listened to:
+   *
+   * - `'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>
+  execute: (data: Data) => Promise<Response>
   /**
    * Shutdowns every current worker in this pool.
    */
-  destroy(): Promise<void>
+  destroy: () => Promise<void>
   /**
-   * Set the worker choice strategy in this pool.
+   * Sets the worker choice strategy in this pool.
    *
-   * @param workerChoiceStrategy The worker choice strategy.
+   * @param workerChoiceStrategy - The worker choice strategy.
    */
-  setWorkerChoiceStrategy(workerChoiceStrategy: WorkerChoiceStrategy): void
+  setWorkerChoiceStrategy: (workerChoiceStrategy: WorkerChoiceStrategy) => void
 }