docs: refine API documentation
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Tue, 21 Nov 2023 21:12:32 +0000 (22:12 +0100)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Tue, 21 Nov 2023 21:12:32 +0000 (22:12 +0100)
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
docs/api.md

index 2b917c46c362157b7616771d2eab174f7dfa9463..8b6ffeb91bb8d5c4627f46ac6a33e77361b1297c 100644 (file)
@@ -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.