docs: refine FIXME comment

[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 5723bd67da6af4b765bcb0e163e48643d48a72e7..9f68c22f892c50a3e424b59a3cb0cffe9f61557f 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -14,6 +14,12 @@ export const WorkerChoiceStrategies = Object.freeze({
    * Least busy worker selection strategy.
    */
   LEAST_BUSY: 'LEAST_BUSY',
+  /**
+   * Least ELU worker selection strategy.
+   *
+   * @experimental
+   */
+  LEAST_ELU: 'LEAST_ELU',
   /**
    * Fair share worker selection strategy.
    */
@@ -35,71 +41,125 @@ export const WorkerChoiceStrategies = Object.freeze({
  */
 export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 
+/**
+ * Enumeration of measurements.
+ */
+export const Measurements = Object.freeze({
+  runTime: 'runTime',
+  waitTime: 'waitTime',
+  elu: 'elu'
+} as const)
+
+/**
+ * Measurement.
+ */
+export type Measurement = keyof typeof Measurements
+
+/**
+ * Measurement options.
+ */
+export interface MeasurementOptions {
+  /**
+   * Set measurement median.
+   */
+  readonly median: boolean
+}
+
 /**
  * Worker choice strategy options.
  */
 export interface WorkerChoiceStrategyOptions {
   /**
-   * Use tasks median runtime instead of average runtime.
+   * Measurement to use for worker choice strategy.
+   */
+  readonly measurement?: Measurement
+  /**
+   * Runtime options.
+   *
+   * @defaultValue \{ median: false \}
+   */
+  readonly runTime?: MeasurementOptions
+  /**
+   * Wait time options.
    *
-   * @defaultValue false
+   * @defaultValue \{ median: false \}
    */
-  medRunTime?: boolean
+  readonly waitTime?: MeasurementOptions
   /**
-   * Use tasks median wait time instead of average runtime.
+   * Event loop utilization options.
    *
-   * @defaultValue false
+   * @defaultValue \{ median: false \}
    */
-  medWaitTime?: boolean
+  readonly elu?: MeasurementOptions
   /**
    * Worker weights to use for weighted round robin worker selection strategy.
    * Weight is the tasks maximum average or median runtime in milliseconds.
    *
    * @defaultValue Computed worker weights automatically given the CPU performance.
    */
-  weights?: Record<number, number>
+  readonly weights?: Record<number, number>
 }
 
 /**
- * Pool worker node worker usage statistics requirements.
+ * Measurement statistics requirements.
  *
  * @internal
  */
-export interface TaskStatisticsRequirements {
+export interface MeasurementStatisticsRequirements {
   /**
-   * Require tasks runtime.
+   * Requires measurement aggregate.
    */
-  runTime: boolean
+  aggregate: boolean
   /**
-   * Require tasks average runtime.
+   * Requires measurement average.
    */
-  avgRunTime: boolean
+  average: boolean
   /**
-   * Require tasks median runtime.
+   * Requires measurement median.
    */
-  medRunTime: boolean
+  median: boolean
+}
+
+/**
+ * Pool worker node worker usage statistics requirements.
+ *
+ * @internal
+ */
+export interface TaskStatisticsRequirements {
   /**
-   * Require tasks wait time.
+   * Tasks runtime requirements.
    */
-  waitTime: boolean
+  readonly runTime: MeasurementStatisticsRequirements
   /**
-   * Require tasks average wait time.
+   * Tasks wait time requirements.
    */
-  avgWaitTime: boolean
+  readonly waitTime: MeasurementStatisticsRequirements
   /**
-   * Require tasks median wait time.
+   * Tasks event loop utilization requirements.
    */
-  medWaitTime: boolean
+  readonly elu: MeasurementStatisticsRequirements
+}
+
+/**
+ * Strategy policy.
+ *
+ * @internal
+ */
+export interface StrategyPolicy {
   /**
-   * Event loop utilization.
+   * Expects direct usage of dynamic worker.
    */
-  elu: boolean
+  readonly useDynamicWorker: boolean
 }
 
 /**
  * Worker choice strategy interface.
  */
 export interface IWorkerChoiceStrategy {
+  /**
+   * Strategy policy.
+   */
+  readonly strategyPolicy: StrategyPolicy
   /**
    * Tasks statistics requirements.
    */