X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=18b0d78a10645439c47d226e9a7587dbfc0fdcbc;hb=353260e334c7f801b1236890f3a0cb8a98ed2b8e;hp=07bcdb10543cf3f52e0adc755ff3dd2f38459fbb;hpb=4c0ada52750183cd0fb1d5e26b6be7d80d042051;p=poolifier.git diff --git a/README.md b/README.md index 07bcdb10..18b0d78a 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:
@@ -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.