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

[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 2207173448458a81be1d383f74a51d4b1b08964a..23dc5e8c9a4e744ed605beeaaca1b38b4e2d944d 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -29,6 +29,16 @@ 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.
  */
@@ -43,7 +53,7 @@ export interface RequiredStatistics {
  */
 export interface IWorkerChoiceStrategy {
   /**
-   * Required pool tasks usage statistics.
+   * Required tasks usage statistics.
    */
   readonly requiredStatistics: RequiredStatistics
   /**
@@ -51,13 +61,13 @@ 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 workerKey - The worker key.
+   * @param workerNodeKey - The worker node key.
    */
-  remove: (workerKey: number) => boolean
+  remove: (workerNodeKey: number) => boolean
 }