fix(ci): silence linter

[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 6a6dfe726d6287690eae99934f0dbaa27722360b..745b140a90873beb9a8bf31d49c48033ea257533 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -1,7 +1,15 @@
 /**
  * Enumeration of worker choice strategies.
  */
-export const WorkerChoiceStrategies = Object.freeze({
+export const WorkerChoiceStrategies: Readonly<{
+  ROUND_ROBIN: 'ROUND_ROBIN'
+  LEAST_USED: 'LEAST_USED'
+  LEAST_BUSY: 'LEAST_BUSY'
+  LEAST_ELU: 'LEAST_ELU'
+  FAIR_SHARE: 'FAIR_SHARE'
+  WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN'
+  INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN'
+}> = Object.freeze({
   /**
    * Round robin worker selection strategy.
    */
@@ -28,10 +36,9 @@ export const WorkerChoiceStrategies = Object.freeze({
   WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN',
   /**
    * Interleaved weighted round robin worker selection strategy.
-   *
    * @experimental
    */
-  INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN'
+  INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN',
 } as const)
 
 /**
@@ -42,10 +49,14 @@ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 /**
  * Enumeration of measurements.
  */
-export const Measurements = Object.freeze({
+export const Measurements: Readonly<{
+  runTime: 'runTime'
+  waitTime: 'waitTime'
+  elu: 'elu'
+}> = Object.freeze({
   runTime: 'runTime',
   waitTime: 'waitTime',
-  elu: 'elu'
+  elu: 'elu',
 } as const)
 
 /**
@@ -67,46 +78,35 @@ export interface MeasurementOptions {
  * Worker choice strategy options.
  */
 export interface WorkerChoiceStrategyOptions {
-  /**
-   * Number of worker choice retries to perform if no worker is eligible.
-   *
-   * @defaultValue 6
-   */
-  readonly choiceRetries?: number
   /**
    * Measurement to use in worker choice strategy supporting it.
    */
   readonly measurement?: Measurement
   /**
    * Runtime options.
-   *
    * @defaultValue \{ median: false \}
    */
   readonly runTime?: MeasurementOptions
   /**
    * Wait time options.
-   *
    * @defaultValue \{ median: false \}
    */
   readonly waitTime?: MeasurementOptions
   /**
    * Event loop utilization options.
-   *
    * @defaultValue \{ median: false \}
    */
   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.
+   * Worker weights to use for weighted round robin worker selection strategies.
+   * A weight is tasks maximum execution time in milliseconds for a worker node.
+   * @defaultValue Weights computed automatically given the CPU performance.
    */
-  readonly weights?: Record<number, number>
+  weights?: Record<number, number>
 }
 
 /**
  * Measurement statistics requirements.
- *
  * @internal
  */
 export interface MeasurementStatisticsRequirements {
@@ -126,7 +126,6 @@ export interface MeasurementStatisticsRequirements {
 
 /**
  * Pool worker node worker usage statistics requirements.
- *
  * @internal
  */
 export interface TaskStatisticsRequirements {
@@ -146,7 +145,6 @@ export interface TaskStatisticsRequirements {
 
 /**
  * Strategy policy.
- *
  * @internal
  */
 export interface StrategyPolicy {
@@ -162,7 +160,6 @@ export interface StrategyPolicy {
 
 /**
  * Worker choice strategy interface.
- *
  * @internal
  */
 export interface IWorkerChoiceStrategy {
@@ -176,34 +173,31 @@ export interface IWorkerChoiceStrategy {
   readonly taskStatisticsRequirements: TaskStatisticsRequirements
   /**
    * Resets strategy internals.
-   *
    * @returns `true` if the reset is successful, `false` otherwise.
    */
   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`.
    */
   readonly choose: () => number | undefined
   /**
    * Removes the worker node key from strategy internals.
-   *
    * @param workerNodeKey - The worker node key.
    * @returns `true` if the worker node key is removed, `false` otherwise.
    */
   readonly remove: (workerNodeKey: number) => boolean
   /**
    * Sets the worker choice strategy options.
-   *
    * @param opts - The worker choice strategy options.
    */
-  readonly setOptions: (opts: WorkerChoiceStrategyOptions) => void
+  readonly setOptions: (opts: WorkerChoiceStrategyOptions | undefined) => void
 }