docs: refine docs/api.md
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Mon, 18 Sep 2023 14:11:28 +0000 (16:11 +0200)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Mon, 18 Sep 2023 14:11:28 +0000 (16:11 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
docs/api.md

index 15760676c1f23e38518a5f19cece8f03308f5b05..8e9d59cd68eef55bd06076e6e3f9f78e62425c13 100644 (file)
@@ -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.