Spell fixlets in comment
authorJérôme Benoit <jerome.benoit@sap.com>
Tue, 11 Oct 2022 09:16:28 +0000 (11:16 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Tue, 11 Oct 2022 09:16:28 +0000 (11:16 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
src/pools/abstract-pool.ts
src/pools/pool.ts
src/pools/selection-strategies/fair-share-worker-choice-strategy.ts
src/pools/selection-strategies/selection-strategies-types.ts
src/pools/selection-strategies/worker-choice-strategy-context.ts

index ab6c094094a29da154b6321e80d0567f675ff802..369e5b90617bab507d97e36331c00a93d6a47c67 100644 (file)
@@ -305,7 +305,7 @@ export abstract class AbstractPool<
   ): void
 
   /**
-   * Register a listener callback on a given worker.
+   * Registers a listener callback on a given worker.
    *
    * @param worker A worker.
    * @param listener A message listener callback.
index 6f677da8ba64d695e5b4b82f904f4b21ef1c7208..e9a093fad6c0287f68f1758a5bc4902d80383317 100644 (file)
@@ -46,7 +46,7 @@ export interface PoolOptions<Worker> {
  */
 export interface IPool<Data = unknown, Response = unknown> {
   /**
-   * Perform the task specified in the constructor with the data parameter.
+   * Performs the task specified in the constructor with the data parameter.
    *
    * @param data The input for the specified task. This can only be serializable data.
    * @returns Promise that will be resolved when the task is successfully completed.
@@ -57,7 +57,7 @@ export interface IPool<Data = unknown, Response = unknown> {
    */
   destroy(): Promise<void>
   /**
-   * Set the worker choice strategy in this pool.
+   * Sets the worker choice strategy in this pool.
    *
    * @param workerChoiceStrategy The worker choice strategy.
    */
index 0d4773ff82f7ee91ce77114da582c59d15f7a201..25a013ea64d604319cfe6d11678f59c8f7435a96 100644 (file)
@@ -55,7 +55,7 @@ export class FairShareWorkerChoiceStrategy<
   }
 
   /**
-   * Compute workers last virtual task timestamp.
+   * Computes workers last virtual task timestamp.
    */
   private updateWorkerLastVirtualTaskTimestamp () {
     for (const worker of this.pool.workers) {
index 4d302f3defb1e7d5619d37693daf4104c944f377..5b844cc572756930980c29991ea3af94ae9a6532 100644 (file)
@@ -49,7 +49,7 @@ export interface IWorkerChoiceStrategy<Worker extends AbstractPoolWorker> {
    */
   requiredStatistics: RequiredStatistics
   /**
-   * Choose a worker in the pool.
+   * Chooses a worker in the pool.
    */
   choose(): Worker
 }
index 8290f89ed9a143a8420a45cb1c5965454bebe35e..a88a8eed1eee1b2f627fcd4b1fe89489e44a8394 100644 (file)
@@ -39,7 +39,7 @@ export class WorkerChoiceStrategyContext<
   }
 
   /**
-   * Get the worker choice strategy instance specific to the pool type.
+   * Gets the worker choice strategy instance specific to the pool type.
    *
    * @param workerChoiceStrategy The worker choice strategy.
    * @returns The worker choice strategy instance for the pool type.
@@ -61,7 +61,7 @@ export class WorkerChoiceStrategyContext<
   }
 
   /**
-   * Get the worker choice strategy used in the context.
+   * Gets the worker choice strategy used in the context.
    *
    * @returns The worker choice strategy.
    */
@@ -70,7 +70,7 @@ export class WorkerChoiceStrategyContext<
   }
 
   /**
-   * Set the worker choice strategy to use in the context.
+   * Sets the worker choice strategy to use in the context.
    *
    * @param workerChoiceStrategy The worker choice strategy to set.
    */
@@ -83,7 +83,7 @@ export class WorkerChoiceStrategyContext<
   }
 
   /**
-   * Choose a worker with the underlying selection strategy.
+   * Chooses a worker with the underlying selection strategy.
    *
    * @returns The chosen one.
    */