docs: refine code comments
authorJérôme Benoit <jerome.benoit@sap.com>
Sun, 20 Aug 2023 11:37:15 +0000 (13:37 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Sun, 20 Aug 2023 11:37:15 +0000 (13:37 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
src/pools/selection-strategies/worker-choice-strategy-context.ts
src/pools/worker.ts

index 51de6e7b79a5cbc28812e41b772b298c86d400ed..7c7574fa7a39f55913282a60bd0becf35e88b6fc 100644 (file)
@@ -168,7 +168,7 @@ export class WorkerChoiceStrategyContext<
    * Executes the worker choice strategy in the context algorithm.
    *
    * @returns The key of the worker node.
-   * @throws {@link https://nodejs.org/api/errors.html#class-error} If the worker node key is null or undefined.
+   * @throws {@link https://nodejs.org/api/errors.html#class-error} If after configured retries the worker node key is null or undefined .
    */
   public execute (): number {
     const workerNodeKey = (
index 1d0c4e22e47f073384bdf8c69e3c477ea9cb1d2b..e4a31e393fad35e06368e3d33cc5820ca1dbd099 100644 (file)
@@ -212,7 +212,7 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
    */
   readonly info: WorkerInfo
   /**
-   * Message channel.
+   * Message channel (worker_threads only).
    */
   readonly messageChannel?: MessageChannel
   /**