From 679e657a0c63a51124bea366c6a05faf7b264185 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Mon, 18 Sep 2023 16:11:28 +0200 Subject: [PATCH] docs: refine docs/api.md MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- docs/api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api.md b/docs/api.md index 15760676..8e9d59cd 100644 --- a/docs/api.md +++ b/docs/api.md @@ -39,7 +39,7 @@ `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'` -`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 +`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. @@ -53,7 +53,7 @@ This method is available on both pool implementations and will call the terminat ### `pool.hasTaskFunction(name)` -`name` (mandatory) The task function name +`name` (mandatory) The task function name. This method is available on both pool implementations and returns a boolean. -- 2.34.1