X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=ab2cf2e49258acf35c267f03d5c88bab91f1428e;hb=f7d15c1217381b306300beb7926b42fde93bc579;hp=212253ffbc5be7faff8760dc3847f9cdc486bb89;hpb=059cf20e59d680db96e1d812dd6320ba9af55c1c;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 212253ff..ab2cf2e4 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -273,12 +273,14 @@ export interface IPool< * If a task function with the same name already exists, it will be overwritten. * * @param name - The name of the task function. - * @param taskFunction - 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, - taskFunction: TaskFunction + fn: TaskFunction ) => Promise /** * Removes a task function from this pool.