chore: generate documentation

[poolifier.git] / README.md

diff --git a/README.md b/README.md
index 49f24ef5e11c6e201568c99f7386716a2933b053..9b1f81317b5a28e920789a096be724b14459f793 100644 (file)
--- a/README.md
+++ b/README.md
@@ -174,7 +174,22 @@ Node versions >= 16.x are supported.
   `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` and `WorkerChoiceStrategies.FAIR_SHARE` strategies are targeted to heavy and long tasks  
   Default: `WorkerChoiceStrategies.ROUND_ROBIN`
 
+- `workerChoiceStrategyOptions` (optional) - The worker choice strategy options object to use in this pool.  
+  Properties:
+
+  - `medRunTime` (optional) - Use the tasks median run time instead of the tasks average run time in worker choice strategies.
+
+  Default: { medRunTime: false }
+
 - `enableEvents` (optional) - Events emission enablement in this pool. Default: true
+- `enableTasksQueue` (optional, experimental) - Tasks queue per worker enablement in this pool. Default: false
+
+- `tasksQueueOptions` (optional, experimental) - The worker tasks queue options object to use in this pool.  
+  Properties:
+
+  - `concurrency` (optional) - The maximum number of tasks that can be executed concurrently on a worker.
+
+  Default: { concurrency: 1 }
 
 ### `pool = new DynamicThreadPool/DynamicClusterPool(min, max, filePath, opts)`