X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=9c67d340c2dca6f057a3ce7c31b00d1f44630609;hb=ac1417a5d54f03b1575de1a53073182ea5f4e2ef;hp=6348511f2d830f9b831d0c2c524f8f77375c4036;hpb=6ccc12622ef20e39e9d1ec36738713a829346cb9;p=poolifier.git diff --git a/README.md b/README.md index 6348511f..9c67d340 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,8 @@ Javascript Standard Style Guide Gitter chat - - Dependabot + + Dependabot PR Welcome @@ -65,7 +65,7 @@ Please consult our general guidelines · Usage · - Node versions + Node versions · API · @@ -146,7 +146,7 @@ Remember that workers can only send and receive serializable data. ## Node versions -You can use node versions 12.x, 13.x, 14.x, 16.x +You can use node versions >= 12.x for thread pool, and node versions >= 16.x for cluster pool. ## API @@ -163,6 +163,8 @@ You can use node versions 12.x, 13.x, 14.x, 16.x - `WorkerChoiceStrategies.ROUND_ROBIN`: Submit tasks to worker in this pool in a round robbin fashion - `WorkerChoiceStrategies.LESS_RECENTLY_USED`: Submit tasks to the less recently used worker in the pool + - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` Submit tasks to worker using a weighted round robin scheduling algorithm based on tasks execution time for now + - `WorkerChoiceStrategies.FAIR_SHARE`: Submit tasks to worker using a fair share tasks scheduling algorithm Default: `WorkerChoiceStrategies.ROUND_ROBIN` @@ -194,7 +196,7 @@ This method will call the terminate method on each worker. The last active time of your worker unit will be updated when a task is submitted to a worker or when a worker terminate a task. If `killBehavior` is set to `KillBehaviors.HARD` this value represents also the timeout for the tasks that you submit to the pool, when this timeout expires your tasks is interrupted and the worker is killed if is not part of the minimum size of the pool. 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: 60.000 ms + Default: 60000 ms - `async` - true/false, true if your function contains async pieces else false - `killBehavior` - Dictates if your async unit (worker/process) will be deleted in case that a task is active on it. @@ -244,13 +246,11 @@ But in general, **always profile your application** ## Contribute See guidelines [CONTRIBUTING](CONTRIBUTING.md) -Choose your task here [2.0.0](https://github.com/poolifier/poolifier/projects/1), propose an idea, a fix, an improvement. +Choose your task here [2.3.0](https://github.com/orgs/poolifier/projects/1), propose an idea, a fix, an improvement. ## Team - - **Creator/Owner:**