From: Jérôme Benoit Date: Tue, 21 Nov 2023 21:12:32 +0000 (+0100) Subject: docs: refine API documentation X-Git-Tag: v3.0.6~10 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=5e4dbac9d427dcd0f6adf9eb84ebb92146d5e1f0;p=poolifier.git docs: refine API documentation Signed-off-by: Jérôme Benoit --- diff --git a/docs/api.md b/docs/api.md index 2b917c46..8b6ffeb9 100644 --- a/docs/api.md +++ b/docs/api.md @@ -43,7 +43,7 @@ `data` (optional) An object that you want to pass to your worker task function 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 [`ThreadWorker`](#class-yourworker-extends-threadworkerclusterworker) worker implementation. This method is available on both pool implementations and returns a promise with the task function execution response.