X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=a0663ba523a765878a4566aafe7a667b9ab220f2;hb=53221c4e8cbcc585c670275e7c1c700c3d1b5f37;hp=4395712f801d3f69961eb6e57bbef6e333d6c713;hpb=027063571693f211b35c8851566a063201adb9af;p=poolifier.git

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 4395712f..a0663ba5 100644
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -16,6 +16,7 @@ import type {
  * Pool types.
  *
  * @enum
+ * @internal
  */
 export enum PoolType {
   /**
@@ -61,7 +62,7 @@ export interface TasksQueueOptions {
 /**
  * Options for a poolifier pool.
  *
- * @typeParam Worker - The worker type.
+ * @typeParam Worker - Type of worker.
  */
 export interface PoolOptions<Worker extends IWorker> {
   /**
@@ -97,14 +98,11 @@ export interface PoolOptions<Worker extends IWorker> {
   /**
    * Pool worker tasks queue.
    *
-   * @experimental
    * @defaultValue false
    */
   enableTasksQueue?: boolean
   /**
    * Pool worker tasks queue options.
-   *
-   * @experimental
    */
   tasksQueueOptions?: TasksQueueOptions
 }
@@ -151,7 +149,7 @@ export interface IPool<
    */
   findFreeWorkerNodeKey: () => number
   /**
-   * Performs the task specified in the constructor with the data parameter.
+   * Executes the function specified in the constructor with the task 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.
@@ -165,6 +163,31 @@ export interface IPool<
    * Sets the worker choice strategy in this pool.
    *
    * @param workerChoiceStrategy - The worker choice strategy.
+   * @param workerChoiceStrategyOptions - The worker choice strategy options.
+   */
+  setWorkerChoiceStrategy: (
+    workerChoiceStrategy: WorkerChoiceStrategy,
+    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
+  ) => void
+  /**
+   * Sets the worker choice strategy options in this pool.
+   *
+   * @param workerChoiceStrategyOptions - The worker choice strategy options.
+   */
+  setWorkerChoiceStrategyOptions: (
+    workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
+  ) => void
+  /**
+   * Enables/disables the worker tasks queue in this pool.
+   *
+   * @param enable - Whether to enable or disable the worker tasks queue.
+   * @param tasksQueueOptions - The worker tasks queue options.
+   */
+  enableTasksQueue: (enable: boolean, opts?: TasksQueueOptions) => void
+  /**
+   * Sets the worker tasks queue options in this pool.
+   *
+   * @param tasksQueueOptions - The worker tasks queue options.
    */
-  setWorkerChoiceStrategy: (workerChoiceStrategy: WorkerChoiceStrategy) => void
+  setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
 }