Initial comment conversion to TSDoc

[poolifier.git] / src / pools / selection-strategies / fair-share-worker-choice-strategy.ts

diff --git a/src/pools/selection-strategies/fair-share-worker-choice-strategy.ts b/src/pools/selection-strategies/fair-share-worker-choice-strategy.ts
index 59dcc3d65ce28cb248beba3b6c57143e7556ec09..00ed1c90aa53592ca1de2b067273f4e6f1de2693 100644 (file)
--- a/src/pools/selection-strategies/fair-share-worker-choice-strategy.ts
+++ b/src/pools/selection-strategies/fair-share-worker-choice-strategy.ts
@@ -5,7 +5,7 @@ import type { RequiredStatistics } from './selection-strategies-types'
 /**
  * Worker virtual task timestamp.
  */
-type WorkerVirtualTaskTimestamp = {
+interface WorkerVirtualTaskTimestamp {
   start: number
   end: number
 }
@@ -14,16 +14,16 @@ type WorkerVirtualTaskTimestamp = {
  * Selects the next worker with a fair share scheduling algorithm.
  * Loosely modeled after the fair queueing algorithm: https://en.wikipedia.org/wiki/Fair_queuing.
  *
- * @template Worker Type of worker which manages the strategy.
- * @template Data Type of data sent to the worker. This can only be serializable data.
- * @template Response Type of response of execution. This can only be serializable data.
+ * @typeParam Worker - Type of worker which manages the strategy.
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of response of execution. This can only be serializable data.
  */
 export class FairShareWorkerChoiceStrategy<
   Worker extends IPoolWorker,
   Data,
   Response
 > extends AbstractWorkerChoiceStrategy<Worker, Data, Response> {
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   public readonly requiredStatistics: RequiredStatistics = {
     runTime: true
   }
@@ -32,17 +32,17 @@ export class FairShareWorkerChoiceStrategy<
    *  Worker last virtual task execution timestamp.
    */
   private readonly workerLastVirtualTaskTimestamp: Map<
-    Worker,
-    WorkerVirtualTaskTimestamp
+  Worker,
+  WorkerVirtualTaskTimestamp
   > = new Map<Worker, WorkerVirtualTaskTimestamp>()
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   public reset (): boolean {
     this.workerLastVirtualTaskTimestamp.clear()
     return true
   }
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   public choose (): Worker {
     let minWorkerVirtualTaskEndTimestamp = Infinity
     let chosenWorker!: Worker
@@ -63,7 +63,7 @@ export class FairShareWorkerChoiceStrategy<
   /**
    * Computes worker last virtual task timestamp.
    *
-   * @param worker The worker.
+   * @param worker - The worker.
    */
   private computeWorkerLastVirtualTaskTimestamp (worker: Worker): void {
     const workerVirtualTaskStartTimestamp = Math.max(