X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=18b0d78a10645439c47d226e9a7587dbfc0fdcbc;hb=dab8c377b70fc962ec217f2aeb719842f9f94cd6;hp=7767c75c1b07c28b96ffbe54a3acbb1e0369461f;hpb=557991e8ddb66a72a47d62606e142e8be86677f2;p=poolifier.git diff --git a/README.md b/README.md index 7767c75c..18b0d78a 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@

Weekly Downloads - - Actions Status + + Actions Status Quality Gate Status @@ -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: @@ -139,8 +139,7 @@ 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. @@ -175,6 +174,7 @@ Node versions >= 16.x are supported. Properties: - `medRunTime` (optional) - Use the tasks median run time instead of the tasks average run time 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.