From: Jérôme Benoit <jerome.benoit@piment-noir.org>
Date: Tue, 19 Sep 2023 12:39:32 +0000 (+0200)
Subject: docs: improve code comments
X-Git-Tag: v2.7.0~1^2
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=cf87987cb8837a0cd6489926498505afceadf533;p=poolifier.git

docs: improve code comments

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

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 7efb3808..ab2cf2e4 100644
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -275,6 +275,8 @@ export interface IPool<
    * @param name - The name of the task function.
    * @param fn - The task function.
    * @returns `true` if the task function was added, `false` otherwise.
+   * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
+   * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `fn` parameter is not a function.
    */
   readonly addTaskFunction: (
     name: string,