refactor: spell fixes
[poolifier.git] / src / pools / selection-strategies / selection-strategies-types.ts
index 114ae8c555141fd08bff0103fcf79d62a65b5f83..ddfe915d2e3c215f9365693c81754155c2c10bc5 100644 (file)
@@ -34,7 +34,7 @@ export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
  */
 export interface WorkerChoiceStrategyOptions {
   /**
-   * Use tasks median run time instead of average run time.
+   * Use tasks median runtime instead of average runtime.
    *
    * @defaultValue false
    */
@@ -55,15 +55,15 @@ export interface WorkerChoiceStrategyOptions {
  */
 export interface RequiredStatistics {
   /**
-   * Require tasks run time.
+   * Require tasks runtime.
    */
   runTime: boolean
   /**
-   * Require tasks average run time.
+   * Require tasks average runtime.
    */
   avgRunTime: boolean
   /**
-   * Require tasks median run time.
+   * Require tasks median runtime.
    */
   medRunTime: boolean
 }
@@ -83,7 +83,7 @@ export interface IWorkerChoiceStrategy {
    */
   reset: () => boolean
   /**
-   * Updates worker node strategy internals.
+   * Updates the worker node key strategy internals.
    *
    * @returns `true` if the update is successful, `false` otherwise.
    */
@@ -95,7 +95,7 @@ export interface IWorkerChoiceStrategy {
    */
   choose: () => number
   /**
-   * Removes a worker node key from strategy internals.
+   * 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.