From: Jérôme Benoit <jerome.benoit@piment-noir.org>
Date: Mon, 28 Aug 2023 18:38:01 +0000 (+0200)
Subject: docs: improve code comment
X-Git-Tag: v2.6.38~24
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=155bb3deed7d21089eba1ea650fe1a9d2c25132e;p=poolifier.git

docs: improve code comment

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
---

diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts
index c00cf083..ca14133f 100644
--- a/src/worker/abstract-worker.ts
+++ b/src/worker/abstract-worker.ts
@@ -429,6 +429,7 @@ export abstract class AbstractWorker<
    * Returns the main worker.
    *
    * @returns Reference to the main worker.
+   * @throws {@link https://nodejs.org/api/errors.html#class-error} If the main worker is not set.
    */
   protected getMainWorker (): MainWorker {
     if (this.mainWorker == null) {