chore: v2.7.4

[poolifier.git] / src / pools / selection-strategies / selection-strategies-types.ts

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 5f2edb25b010f9961fcf870c6e661d98abaf0663..5d490638ad2dbb9348cad7318b2258b83cbdad95 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -72,7 +72,7 @@ export interface WorkerChoiceStrategyOptions {
    *
    * @defaultValue 6
    */
-  readonly choiceRetries?: number
+  readonly retries?: number
   /**
    * Measurement to use in worker choice strategy supporting it.
    */
@@ -97,7 +97,7 @@ export interface WorkerChoiceStrategyOptions {
   readonly elu?: MeasurementOptions
   /**
    * Worker weights to use for weighted round robin worker selection strategies.
-   * A weight is the tasks maximum execution in milliseconds for each worker node.
+   * A weight is tasks maximum execution time in milliseconds for a worker node.
    *
    * @defaultValue Weights computed automatically given the CPU performance.
    */
@@ -182,13 +182,15 @@ export interface IWorkerChoiceStrategy {
   readonly reset: () => boolean
   /**
    * Updates the worker node key strategy internals.
+   * This is called after a task has been executed on a worker node.
    *
    * @returns `true` if the update is successful, `false` otherwise.
    */
   readonly update: (workerNodeKey: number) => boolean
   /**
    * Chooses a worker node in the pool and returns its key.
-   * If the worker node is not eligible, `undefined` is returned.
+   * If no worker nodes are not eligible, `undefined` is returned.
+   * If `undefined` is returned, the caller retry.
    *
    * @returns The worker node key or `undefined`.
    */