docs: add missing exports

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

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index e8f391cc4dc3c6f399194d82d93e92ec00c22dfc..fe03741a68254c686991c5ed6b222857e1ff70c8 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -1,4 +1,126 @@
+import EventEmitter from 'node:events'
+import type {
+  ErrorHandler,
+  ExitHandler,
+  IWorker,
+  MessageHandler,
+  OnlineHandler
+} from './worker'
+import type {
+  WorkerChoiceStrategy,
+  WorkerChoiceStrategyOptions
+} 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
+
+/**
+ * Worker tasks queue options.
+ */
+export interface TasksQueueOptions {
+  /**
+   * Maximum number of tasks that can be executed concurrently on a worker.
+   *
+   * @defaultValue 1
+   */
+  concurrency?: number
+}
+
+/**
+ * Options for a poolifier pool.
+ */
+export interface PoolOptions<Worker extends IWorker> {
+  /**
+   * A function that will listen for message event on each worker.
+   */
+  messageHandler?: MessageHandler<Worker>
+  /**
+   * A function that will listen for error event on each worker.
+   */
+  errorHandler?: ErrorHandler<Worker>
+  /**
+   * A function that will listen for online event on each worker.
+   */
+  onlineHandler?: OnlineHandler<Worker>
+  /**
+   * A function that will listen for exit event on each worker.
+   */
+  exitHandler?: ExitHandler<Worker>
+  /**
+   * The worker choice strategy to use in this pool.
+   */
+  workerChoiceStrategy?: WorkerChoiceStrategy
+  /**
+   * The worker choice strategy options.
+   */
+  workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
+  /**
+   * Pool events emission.
+   *
+   * @defaultValue true
+   */
+  enableEvents?: boolean
+  /**
+   * Pool worker tasks queue.
+   *
+   * @experimental
+   * @defaultValue false
+   */
+  enableTasksQueue?: boolean
+  /**
+   * Pool worker tasks queue options.
+   *
+   * @experimental
+   */
+  tasksQueueOptions?: TasksQueueOptions
+}
+
+/**
+ * Contract definition for a poolifier pool.
+ *
+ * @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> {
-  destroy(): Promise<void>
-  execute(data: Data): Promise<Response>
+  /**
+   * 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.
+   * @returns Promise that will be resolved when the task is successfully completed.
+   */
+  execute: (data: Data) => Promise<Response>
+  /**
+   * Shutdowns every current worker in this pool.
+   */
+  destroy: () => Promise<void>
+  /**
+   * Sets the worker choice strategy in this pool.
+   *
+   * @param workerChoiceStrategy - The worker choice strategy.
+   */
+  setWorkerChoiceStrategy: (workerChoiceStrategy: WorkerChoiceStrategy) => void
 }