X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=9b1f81317b5a28e920789a096be724b14459f793;hb=12ae3210477b0c54380db24470ff3b0e78926bd8;hp=13c8c7fe1f43f4da61a24e5b522d00599c245280;hpb=ff733df7ebd4813628b27a5d27d509163e12af84;p=poolifier.git diff --git a/README.md b/README.md index 13c8c7fe..9b1f8131 100644 --- a/README.md +++ b/README.md @@ -174,9 +174,23 @@ 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)` `min` (mandatory) Same as FixedThreadPool/FixedClusterPool numberOfThreads/numberOfWorkers, this number of workers will be always active