docs: add code comment
authorJérôme Benoit <jerome.benoit@sap.com>
Sat, 15 Jul 2023 14:31:37 +0000 (16:31 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Sat, 15 Jul 2023 14:31:37 +0000 (16:31 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
src/pools/selection-strategies/abstract-worker-choice-strategy.ts

index 01beb340dad7c59ac0b361f576382a66e42e1b9a..6bd4fe741ce403b282034ba4d3559a3faf93bbfa 100644 (file)
@@ -123,6 +123,12 @@ export abstract class AbstractWorkerChoiceStrategy<
     this.setTaskStatisticsRequirements(this.opts)
   }
 
+  /**
+   * Whether the worker node is ready or not.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns Whether the worker node is ready or not.
+   */
   protected isWorkerNodeReady (workerNodeKey: number): boolean {
     return this.pool.workerNodes[workerNodeKey].info.ready
   }