docs(api): add missing tasksStealingRatio default value
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Sat, 3 Aug 2024 20:56:25 +0000 (22:56 +0200)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Sat, 3 Aug 2024 20:56:25 +0000 (22:56 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
docs/api.md

index bf1411116e0fb012c43023019d3824069226f033..580dfd2b4cdaf3c8e83dffa3c40892850448b628 100644 (file)
@@ -147,7 +147,7 @@ An object with these properties:
   - `tasksStealingRatio` (optional) - The ratio of worker nodes that can steal tasks from another worker node. It must be a number between 0 and 1.
   - `tasksFinishedTimeout` (optional) - Queued tasks finished timeout in milliseconds at worker termination.
 
-  Default: `{ size: (pool maximum size)^2, concurrency: 1, taskStealing: true, tasksStealingOnBackPressure: false, tasksFinishedTimeout: 2000 }`
+  Default: `{ size: (pool maximum size)^2, concurrency: 1, taskStealing: true, tasksStealingOnBackPressure: false, tasksStealingRatio: 0.6, tasksFinishedTimeout: 2000 }`
 
 - `workerOptions` (optional) - An object with the worker options to pass to worker. See [worker_threads](https://nodejs.org/api/worker_threads.html#worker_threads_new_worker_filename_options) for more details.