chore: generate documentation

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

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 396c59ad987ea5c9e8294190587917d8036990b5..f6188d8e7420cda156815baebe4821029c3b34c6 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
   /**
@@ -139,22 +141,12 @@ export interface IPool<
    */
   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
-  /**
-   * Executes the function specified in the constructor with the task data parameter.
+   * Executes the function specified in the worker constructor with the task data input 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.
+   * @param data - The task input data for the specified worker function. This can only be serializable data.
+   * @returns Promise that will be fulfilled when the task is completed.
    */
-  execute: (data: Data) => Promise<Response>
+  execute: (data?: Data) => Promise<Response>
   /**
    * Shutdowns every current worker in this pool.
    */