From: Jérôme Benoit Date: Sat, 12 Aug 2023 12:38:02 +0000 (+0200) Subject: docs: fix API documentation X-Git-Tag: v2.6.24~1 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=637100d9f7507bb89a42120c7dec2f0db688b1a5;p=poolifier.git docs: fix API documentation Signed-off-by: Jérôme Benoit --- diff --git a/docs/api.md b/docs/api.md index 9662c298..d45702c7 100644 --- a/docs/api.md +++ b/docs/api.md @@ -36,7 +36,7 @@ ### `pool.execute(data, name, transferList)` `data` (optional) An object that you want to pass to your worker implementation -`name` (optional) A string with the task function name that you want to execute on the worker. Default: `'default'` +`name` (optional) A string with the task function name that you want to execute on the worker. Default: `'default'` `transferList` (optional) An array of transferable objects that you want to transfer to your [worker_threads](https://nodejs.org/api/worker_threads.html) worker implementation This method is available on both pool implementations and returns a promise with the task function execution response.