refactor: spell fixes

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>

diff --git a/CHANGELOG.md b/CHANGELOG.md
index f5c05bb17dc5dde98e6fb5def5c13e341be2b983..200e61ddef934198b82a2d45515e9b86c7c5b7b0 100644 (file)
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -99,8 +99,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Use monotonic high resolution timer for worker tasks run time.
-- Add worker tasks median run time to statistics.
+- Use monotonic high resolution timer for worker tasks runtime.
+- Add worker tasks median runtime to statistics.
 - Add worker tasks queue (experimental).
 
 ## [2.4.4] - 2023-04-07

diff --git a/README.md b/README.md
index 1b7e641b40bd27313756961437e09f1ab5a9db0c..3eeebed184aa73b2417537a8b3e3e48d5af10f8a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -173,7 +173,7 @@ Node versions >= 16.14.x are supported.
 - `workerChoiceStrategyOptions` (optional) - The worker choice strategy options object to use in this pool.  
   Properties:
 
-  - `medRunTime` (optional) - Use the tasks median run time instead of the tasks average run time in worker choice strategies.
+  - `medRunTime` (optional) - Use the tasks median runtime instead of the tasks average runtime in worker choice strategies.
   - `weights` (optional) - The worker weights to use in the weighted round robin worker choice strategy: `{ 0: 200, 1: 300, ..., n: 100 }`
 
   Default: `{ medRunTime: false }`

diff --git a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
index ad42f9184c78e5116332a507c003cd4530f8da9e..efa9578d8b2f889630aadec6da595ded93cd087f 100644 (file)
--- a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
+++ b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
@@ -99,12 +99,12 @@ export abstract class AbstractWorkerChoiceStrategy<
   }
 
   /**
-   * Gets the worker task run time.
-   * If the required statistics are `avgRunTime`, the average run time is returned.
-   * If the required statistics are `medRunTime`, the median run time is returned.
+   * Gets the worker task runtime.
+   * If the required statistics are `avgRunTime`, the average runtime is returned.
+   * If the required statistics are `medRunTime`, the median runtime is returned.
    *
    * @param workerNodeKey - The worker node key.
-   * @returns The worker task run time.
+   * @returns The worker task runtime.
    */
   protected getWorkerTaskRunTime (workerNodeKey: number): number {
     return this.requiredStatistics.medRunTime

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 94e2d3e6d3a8df349cf8aea49bb725dbdeaae4d4..d132c877fc6f9d8d25010206922e516cdb259168 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -34,13 +34,13 @@ 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
    */
   medRunTime?: boolean
   /**
-   * Use tasks median wait time instead of average run time.
+   * Use tasks median wait time instead of average runtime.
    *
    * @defaultValue false
    */
@@ -61,15 +61,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
   /**

diff --git a/tests/pools/selection-strategies/selection-strategies.test.js b/tests/pools/selection-strategies/selection-strategies.test.js
index 11a9aab3caa2001b799d5a8e48526481cef7da19..33d2114c09bc4e02eb45f2f46a7b5d13537e9911 100644 (file)
--- a/tests/pools/selection-strategies/selection-strategies.test.js
+++ b/tests/pools/selection-strategies/selection-strategies.test.js
@@ -466,7 +466,7 @@ describe('Selection strategies test suite', () => {
     await pool.destroy()
   })
 
-  it('Verify FAIR_SHARE strategy can be run in a dynamic pool with median run time statistic', async () => {
+  it('Verify FAIR_SHARE strategy can be run in a dynamic pool with median runtime statistic', async () => {
     const pool = new DynamicThreadPool(
       min,
       max,
@@ -671,7 +671,7 @@ describe('Selection strategies test suite', () => {
     await pool.destroy()
   })
 
-  it('Verify WEIGHTED_ROUND_ROBIN strategy can be run in a dynamic pool with median run time statistic', async () => {
+  it('Verify WEIGHTED_ROUND_ROBIN strategy can be run in a dynamic pool with median runtime statistic', async () => {
     const pool = new DynamicThreadPool(
       min,
       max,

diff --git a/tests/pools/selection-strategies/worker-choice-strategy-context.test.js b/tests/pools/selection-strategies/worker-choice-strategy-context.test.js
index f04013d99c92ad0e61dae665f79df61dda1d2274..fa380a5ae4320f0f4056bd48462e940992c60288 100644 (file)
--- a/tests/pools/selection-strategies/worker-choice-strategy-context.test.js
+++ b/tests/pools/selection-strategies/worker-choice-strategy-context.test.js
@@ -322,7 +322,7 @@ describe('Worker choice strategy context test suite', () => {
     )
   })
 
-  it('Verify that worker choice strategy options enable median run time pool statistics', () => {
+  it('Verify that worker choice strategy options enable median runtime pool statistics', () => {
     const wwrWorkerChoiceStrategy = WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN
     let workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
       fixedPool,