X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=52650f3e72b10aa40fc4bd427206e634ca836ad1;hb=ace229a1b5029d3acaeeb4e8abdab415de5318f1;hp=c5dd07ad504c127e389eae815e7428167a5c41ef;hpb=31ce819c252a2aa74171548f48b0bd38e546c8f7;p=poolifier.git diff --git a/README.md b/README.md index c5dd07ad..52650f3e 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@
-
-
+
+
@@ -37,8 +37,8 @@ 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:
@@ -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,8 +162,8 @@ 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.FAIR_SHARE`: Submit tasks to worker using a fair share tasks scheduling algorithm based on tasks execution time
@@ -173,7 +173,7 @@ 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 }`
@@ -218,8 +218,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.