From 637100d9f7507bb89a42120c7dec2f0db688b1a5 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Sat, 12 Aug 2023 14:38:02 +0200 Subject: [PATCH] docs: fix API documentation MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- docs/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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. -- 2.34.1