Bump @types/node from 14.14.31 to 14.14.32 (#258)
[poolifier.git] / src / pools / pool.ts
index 55e15792b01f23a4305e42f3d4fe4689e7dbaf05..752045829214f76681f92d36fce414c581fd0c95 100644 (file)
@@ -1,19 +1,27 @@
+import type { WorkerChoiceStrategy } from './selection-strategies'
+
 /**
  * Contract definition for a poolifier pool.
  *
- * @template Data Type of data sent to the worker.
- * @template Response Type of response of execution.
+ * @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.
  */
 export interface IPool<Data = unknown, Response = unknown> {
+  /**
+   * Perform 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>
   /**
    * Shut down every current worker in this pool.
    */
   destroy(): Promise<void>
   /**
-   * Perform the task specified in the constructor with the data parameter.
+   * Set the worker choice strategy in this pool.
    *
-   * @param data The input for the specified task.
-   * @returns Promise that will be resolved when the task is successfully completed.
+   * @param workerChoiceStrategy The worker choice strategy.
    */
-  execute(data: Data): Promise<Response>
+  setWorkerChoiceStrategy(workerChoiceStrategy: WorkerChoiceStrategy): void
 }