X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=d8cdf2b16bd64e22b57148fd9e7ffa6afbbefc89;hb=1ab50fe5ad0b27a13a48047f9414d4138d43a5cd;hp=7767c75c1b07c28b96ffbe54a3acbb1e0369461f;hpb=9f8f5811bfbaae8f44976880045faef15bd0387f;p=poolifier.git diff --git a/README.md b/README.md index 7767c75c..d8cdf2b1 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@

Weekly Downloads - - Actions Status + + Actions Status Quality Gate Status @@ -37,12 +37,13 @@ Please consult our [general guidelines](#general-guidance). - Performance :racehorse: [benchmarks](./benchmarks/README.md) - Security :bank: :cop: [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=security_rating)](https://sonarcloud.io/dashboard?id=pioardi_poolifier) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=pioardi_poolifier) - Easy to use :couple: -- Easy switch from a pool to another, easy to tune :white_check_mark: - Dynamic pool size :white_check_mark: +- Easy switch from a pool to another :white_check_mark: - No runtime dependencies :white_check_mark: - Proper async integration with node async hooks :white_check_mark: - Support for worker threads and cluster node modules :white_check_mark: - Support sync and async tasks :white_check_mark: +- Tasks distribution strategies :white_check_mark: - General guidance on pools to use :white_check_mark: - Widely tested :white_check_mark: - Error handling out of the box :white_check_mark: @@ -139,14 +140,13 @@ pool.execute({}).then(res => { You can do the same with the classes ClusterWorker, FixedClusterPool and DynamicClusterPool. -**See examples folder for more details (in particular if you want to use a pool with [multiple worker functions](./examples/multiFunctionExample.js))**. -**Now TypeScript is also supported, find how to use it into the example folder**. +**See examples folder for more details (in particular if you want to use a pool with [multiple worker functions](./examples/multiFunctionExample.js))**. 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/) @@ -163,21 +163,25 @@ 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 worker with the minimum number of running and ran tasks + - `WorkerChoiceStrategies.LEAST_BUSY`: Submit tasks to the worker with the minimum tasks total execution time - `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. + `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN`, `WorkerChoiceStrategies.INTERLEAVED_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. + - `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 +222,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.