chore: v2.4.9
[poolifier.git] / src / pools / pool.ts
index a0663ba523a765878a4566aafe7a667b9ab220f2..f4a1791504f16964c94f378be5a35b066e0cc0e9 100644 (file)
@@ -83,6 +83,8 @@ export interface PoolOptions<Worker extends IWorker> {
   exitHandler?: ExitHandler<Worker>
   /**
    * The worker choice strategy to use in this pool.
+   *
+   * @defaultValue WorkerChoiceStrategies.ROUND_ROBIN
    */
   workerChoiceStrategy?: WorkerChoiceStrategy
   /**
@@ -149,9 +151,9 @@ export interface IPool<
    */
   findFreeWorkerNodeKey: () => number
   /**
-   * Executes the function specified in the constructor with the task data parameter.
+   * Executes the function specified in the constructor with the task data input parameter.
    *
-   * @param data - The input for the specified task. This can only be serializable data.
+   * @param data - The task input data for the specified function. This can only be serializable data.
    * @returns Promise that will be resolved when the task is successfully completed.
    */
   execute: (data: Data) => Promise<Response>
@@ -183,7 +185,10 @@ export interface IPool<
    * @param enable - Whether to enable or disable the worker tasks queue.
    * @param tasksQueueOptions - The worker tasks queue options.
    */
-  enableTasksQueue: (enable: boolean, opts?: TasksQueueOptions) => void
+  enableTasksQueue: (
+    enable: boolean,
+    tasksQueueOptions?: TasksQueueOptions
+  ) => void
   /**
    * Sets the worker tasks queue options in this pool.
    *