From: Jérôme Benoit Date: Thu, 18 Jul 2024 18:03:16 +0000 (+0200) Subject: docs(api.md): document tasksStealingRatio tasks queue option X-Git-Tag: v4.1.0~2 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=453c6467536356616003ea3666fd4d14ef539e26;p=poolifier.git docs(api.md): document tasksStealingRatio tasks queue option Signed-off-by: Jérôme Benoit --- diff --git a/docs/api.md b/docs/api.md index 7c206c78..bf141111 100644 --- 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 }`