docs(api.md): document tasksStealingRatio tasks queue option

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>

diff --git a/docs/api.md b/docs/api.md
index 7c206c78ea1581f9691cd52ed47d36be9296ce17..bf1411116e0fb012c43023019d3824069226f033 100644 (file)
--- a/docs/api.md
+++ b/docs/api.md
@@ -144,6 +144,7 @@ An object with these properties:
   - `concurrency` (optional) - The maximum number of tasks that can be executed concurrently on a worker. It must be a positive integer.
   - `taskStealing` (optional) - Task stealing enablement on idle.
   - `tasksStealingOnBackPressure` (optional) - Tasks stealing enablement under back pressure.
+  - `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 }`