X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=1a311e4d5fcec3b0a46125e11ffb42f7853b18d3;hb=70353024c44987c467dadcec306c699ce4ae1f06;hp=6d4c35ef38f0ab795cdc2a5f257fc85b9df62bdd;hpb=e42a859c7485e371e6d9d6fb80b9c057aafa3664;p=poolifier.git diff --git a/README.md b/README.md index 6d4c35ef..1a311e4d 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,7 @@ Remember that workers can only send and receive serializable data. ## Node versions -Node versions >= 16.x are supported. +Node versions >= 16.14.x are supported. ## [API](https://poolifier.github.io/poolifier/) @@ -162,9 +162,10 @@ Node versions >= 16.x are supported. - `workerChoiceStrategy` (optional) - The worker choice strategy to use in this pool: - `WorkerChoiceStrategies.ROUND_ROBIN`: Submit tasks to worker in a round robbin fashion - - `WorkerChoiceStrategies.LESS_USED`: Submit tasks to the less used worker - - `WorkerChoiceStrategies.LESS_BUSY`: Submit tasks to the less busy worker + - `WorkerChoiceStrategies.LEAST_USED`: Submit tasks to the least used worker + - `WorkerChoiceStrategies.LEAST_BUSY`: Submit tasks to the least busy worker - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN`: Submit tasks to worker using a weighted round robin scheduling algorithm based on tasks execution time + - `WorkerChoiceStrategies.INTERLEAVED_WEIGHTED_ROUND_ROBIN`: Submit tasks to worker using an interleaved weighted round robin scheduling algorithm based on tasks execution time (experimental) - `WorkerChoiceStrategies.FAIR_SHARE`: Submit tasks to worker using a fair share tasks scheduling algorithm based on tasks execution time `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` and `WorkerChoiceStrategies.FAIR_SHARE` strategies are targeted to heavy and long tasks. @@ -173,11 +174,13 @@ Node versions >= 16.x are supported. - `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. + - `medRunTime` (optional) - Use the tasks median runtime instead of the tasks average runtime in worker choice strategies. - `weights` (optional) - The worker weights to use in the weighted round robin worker choice strategy: `{ 0: 200, 1: 300, ..., n: 100 }` Default: `{ medRunTime: false }` +- `restartWorkerOnError` (optional) - Restart worker on uncaught error in this pool. + Default: true - `enableEvents` (optional) - Events emission enablement in this pool. Default: true - `enableTasksQueue` (optional) - Tasks queue per worker enablement in this pool. @@ -218,8 +221,6 @@ This method will call the terminate method on each worker. If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed. Default: 60000 -- `async` (optional) - true/false. Set to true if your function contains async code pieces, else false. - Default: false - `killBehavior` (optional) - Dictates if your async unit (worker/process) will be deleted in case that a task is active on it. **KillBehaviors.SOFT**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker **won't** be deleted. **KillBehaviors.HARD**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted.