feat: add pool runtime setters

[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 2c6c2e16d6e4d52e7f19841e6d6f331db3d678f9..f9a504351a4bbbe9d33bddc145c457a7ce27ef78 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -29,12 +29,34 @@ export const WorkerChoiceStrategies = Object.freeze({
  */
 export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 
+/**
+ * Worker choice strategy options.
+ */
+export interface WorkerChoiceStrategyOptions {
+  /**
+   * Use tasks median run time instead of average run time.
+   */
+  medRunTime?: boolean
+}
+
 /**
  * Pool worker tasks usage statistics requirements.
+ *
+ * @internal
  */
 export interface RequiredStatistics {
+  /**
+   * Require tasks run time.
+   */
   runTime: boolean
+  /**
+   * Require tasks average run time.
+   */
   avgRunTime: boolean
+  /**
+   * Require tasks median run time.
+   */
+  medRunTime: boolean
 }
 
 /**
@@ -42,7 +64,7 @@ export interface RequiredStatistics {
  */
 export interface IWorkerChoiceStrategy {
   /**
-   * Required pool tasks usage statistics.
+   * Required tasks usage statistics.
    */
   readonly requiredStatistics: RequiredStatistics
   /**
@@ -50,13 +72,19 @@ export interface IWorkerChoiceStrategy {
    */
   reset: () => boolean
   /**
-   * Chooses a worker in the pool and returns its key.
+   * Chooses a worker node in the pool and returns its key.
    */
   choose: () => number
   /**
-   * Removes a worker reference from strategy internals.
+   * Removes a worker node key from strategy internals.
+   *
+   * @param workerNodeKey - The worker node key.
+   */
+  remove: (workerNodeKey: number) => boolean
+  /**
+   * Sets the worker choice strategy options.
    *
-   * @param workerKey - The worker key.
+   * @param opts - The worker choice strategy options.
    */
-  remove: (workerKey: number) => boolean
+  setOptions: (opts: WorkerChoiceStrategyOptions) => void
 }