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 7efb3808fa8e02ae6c294665461453c48e1a8451..ab2cf2e49258acf35c267f03d5c88bab91f1428e 100644 (file)
--- 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,