From: Jérôme Benoit Date: Sun, 20 Aug 2023 11:37:15 +0000 (+0200) Subject: docs: refine code comments X-Git-Tag: v2.6.31~1 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=336e91c4a22c1c67f0f1cff28dbbb18bff8d8083;p=poolifier.git docs: refine code comments Signed-off-by: Jérôme Benoit --- diff --git a/src/pools/selection-strategies/worker-choice-strategy-context.ts b/src/pools/selection-strategies/worker-choice-strategy-context.ts index 51de6e7b..7c7574fa 100644 --- a/src/pools/selection-strategies/worker-choice-strategy-context.ts +++ b/src/pools/selection-strategies/worker-choice-strategy-context.ts @@ -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 = ( diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 1d0c4e22..e4a31e39 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -212,7 +212,7 @@ export interface IWorkerNode { */ readonly info: WorkerInfo /** - * Message channel. + * Message channel (worker_threads only). */ readonly messageChannel?: MessageChannel /**