docs: enhance documentation

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

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index f1da5356a2e5310d799b6e595a898a3aad783600..17088559a32620f48175cb273bf709f6af817a90 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -2,10 +2,31 @@ import EventEmitter from 'node:events'
 import type {
   ErrorHandler,
   ExitHandler,
+  IWorker,
   MessageHandler,
-  OnlineHandler
-} from './pool-worker'
-import type { WorkerChoiceStrategy } from './selection-strategies/selection-strategies-types'
+  OnlineHandler,
+  WorkerNode
+} from './worker'
+import type {
+  WorkerChoiceStrategy,
+  WorkerChoiceStrategyOptions
+} from './selection-strategies/selection-strategies-types'
+
+/**
+ * Pool types.
+ *
+ * @enum
+ */
+export enum PoolType {
+  /**
+   * Fixed pool type.
+   */
+  FIXED = 'fixed',
+  /**
+   * Dynamic pool type.
+   */
+  DYNAMIC = 'dynamic'
+}
 
 /**
  * Pool events emitter.
@@ -25,10 +46,24 @@ export const PoolEvents = Object.freeze({
  */
 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.
+ *
+ * @typeParam Worker - The worker type.
  */
-export interface PoolOptions<Worker> {
+export interface PoolOptions<Worker extends IWorker> {
   /**
    * A function that will listen for message event on each worker.
    */
@@ -49,21 +84,53 @@ export interface PoolOptions<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 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 response of execution. This can only be serializable data.
  */
-export interface IPool<Data = unknown, Response = unknown> {
+export interface IPool<
+  Worker extends IWorker,
+  Data = unknown,
+  Response = unknown
+> {
+  /**
+   * Pool type.
+   *
+   * If it is `'dynamic'`, it provides the `max` property.
+   */
+  readonly type: PoolType
+  /**
+   * Pool worker nodes.
+   */
+  readonly workerNodes: Array<WorkerNode<Worker, Data>>
   /**
    * Emitter on which events can be listened to.
    *
@@ -73,6 +140,16 @@ export interface IPool<Data = unknown, Response = unknown> {
    * - `'busy'`: Emitted when the pool is busy.
    */
   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
   /**
    * Performs the task specified in the constructor with the data parameter.
    *