From cf87987cb8837a0cd6489926498505afceadf533 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Tue, 19 Sep 2023 14:39:32 +0200 Subject: [PATCH] docs: improve code comments MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- src/pools/pool.ts | 2 ++ 1 file changed, 2 insertions(+) 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, -- 2.34.1