docs: improve code comment
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Mon, 28 Aug 2023 18:38:01 +0000 (20:38 +0200)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Mon, 28 Aug 2023 18:38:01 +0000 (20:38 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
src/worker/abstract-worker.ts

index c00cf08320c261c40d857b7bcb7788a47f9561e7..ca14133f2dafa7b1d6692f84459bafabb431e935 100644 (file)
@@ -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) {