build(deps-dev): bump @types/node
[poolifier.git] / src / pools / selection-strategies / worker-choice-strategy-context.ts
index 7862fb38536b702e850843dc77d6303b637eada4..122774dd0e48c157d5d7c7ce5bdc4ea590281087 100644 (file)
@@ -9,7 +9,8 @@ import { LeastEluWorkerChoiceStrategy } from './least-elu-worker-choice-strategy
 import { RoundRobinWorkerChoiceStrategy } from './round-robin-worker-choice-strategy'
 import type {
   IWorkerChoiceStrategy,
-  TaskStatistics,
+  StrategyPolicy,
+  TaskStatisticsRequirements,
   WorkerChoiceStrategy,
   WorkerChoiceStrategyOptions
 } from './selection-strategies-types'
@@ -20,8 +21,8 @@ import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-w
  * The worker choice strategy context.
  *
  * @typeParam Worker - Type of worker.
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
  */
 export class WorkerChoiceStrategyContext<
   Worker extends IWorker,
@@ -105,16 +106,29 @@ export class WorkerChoiceStrategyContext<
   }
 
   /**
-   * Gets the worker choice strategy task statistics in the context.
+   * Gets the strategy policy in the context.
    *
-   * @returns The task statistics.
+   * @returns The strategy policy.
    */
-  public getTaskStatistics (): TaskStatistics {
+  public getStrategyPolicy (): StrategyPolicy {
     return (
       this.workerChoiceStrategies.get(
         this.workerChoiceStrategy
       ) as IWorkerChoiceStrategy
-    ).taskStatistics
+    ).strategyPolicy
+  }
+
+  /**
+   * Gets the worker choice strategy task statistics requirements in the context.
+   *
+   * @returns The task statistics requirements.
+   */
+  public getTaskStatisticsRequirements (): TaskStatisticsRequirements {
+    return (
+      this.workerChoiceStrategies.get(
+        this.workerChoiceStrategy
+      ) as IWorkerChoiceStrategy
+    ).taskStatisticsRequirements
   }
 
   /**
@@ -157,7 +171,7 @@ export class WorkerChoiceStrategyContext<
       ) as IWorkerChoiceStrategy
     ).choose()
     if (workerNodeKey == null) {
-      throw new Error('Worker node key chosen is null or undefined')
+      throw new TypeError('Worker node key chosen is null or undefined')
     }
     return workerNodeKey
   }
@@ -165,7 +179,7 @@ export class WorkerChoiceStrategyContext<
   /**
    * Removes the worker node key from the worker choice strategy in the context.
    *
-   * @param workerNodeKey - The key of the worker node.
+   * @param workerNodeKey - The worker node key.
    * @returns `true` if the removal is successful, `false` otherwise.
    */
   public remove (workerNodeKey: number): boolean {