From: Jérôme Benoit Date: Mon, 18 Sep 2023 14:11:28 +0000 (+0200) Subject: docs: refine docs/api.md X-Git-Tag: v2.7.0~1^2~15 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=679e657a0c63a51124bea366c6a05faf7b264185;p=poolifier.git docs: refine docs/api.md Signed-off-by: Jérôme Benoit --- 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.