From: Jérôme Benoit <jerome.benoit@piment-noir.org>
Date: Thu, 9 May 2024 17:31:40 +0000 (+0200)
Subject: fix: fix pool.addTaskFunction() type definition
X-Git-Tag: v4.0.6~5
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;ds=sidebyside;h=f57ca5d5136bb599299420ad483e00e1344eca1d;hp=-c;p=poolifier.git

fix: fix pool.addTaskFunction() type definition

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

f57ca5d5136bb599299420ad483e00e1344eca1d
diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 66815bf9..67409eea 100644
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -3,7 +3,10 @@ import type { EventEmitterAsyncResource } from 'node:events'
 import type { TransferListItem, WorkerOptions } from 'node:worker_threads'
 
 import type { TaskFunctionProperties } from '../utility-types.js'
-import type { TaskFunction } from '../worker/task-functions.js'
+import type {
+  TaskFunction,
+  TaskFunctionObject
+} from '../worker/task-functions.js'
 import type {
   WorkerChoiceStrategy,
   WorkerChoiceStrategyOptions
@@ -308,11 +311,11 @@ export interface IPool<
    * @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.
+   * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `fn` parameter is not a function or task function object.
    */
   readonly addTaskFunction: (
     name: string,
-    fn: TaskFunction<Data, Response>
+    fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>
   ) => Promise<boolean>
   /**
    * Removes a task function from this pool.