Merge branch 'master' of github.com:poolifier/poolifier

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

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index ea60833a42b445921ef162d15d651a9ba32d6127..f4a1791504f16964c94f378be5a35b066e0cc0e9 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -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>
@@ -163,8 +165,12 @@ 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) => void
+  setWorkerChoiceStrategy: (
+    workerChoiceStrategy: WorkerChoiceStrategy,
+    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
+  ) => void
   /**
    * Sets the worker choice strategy options in this pool.
    *
@@ -179,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.
    *