X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=6d4c35ef38f0ab795cdc2a5f257fc85b9df62bdd;hb=784a9a1f6a43ffb056b4ba534e49313ba50f3586;hp=012acc86088ee1f6ff8b2ff362236c82765719a5;hpb=124119cf66af88a8583aef7ff2e41b855b0a8937;p=poolifier.git diff --git a/README.md b/README.md index 012acc86..6d4c35ef 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,11 @@
-
-
+
+
-
+
@@ -29,7 +29,7 @@
## Why Poolifier?
-Poolifier is used to perform CPU intensive and I/O intensive tasks on nodejs servers, it implements worker pools (yes, more worker pool implementations, so you can choose which one fit better for you) using [worker-threads](https://nodejs.org/api/worker_threads.html#worker_threads_worker_threads) and cluster pools using [Node.js cluster](https://nodejs.org/api/cluster.html) modules.
+Poolifier is used to perform CPU intensive and I/O intensive tasks on nodejs servers, it implements worker pools using [worker-threads](https://nodejs.org/api/worker_threads.html#worker_threads_worker_threads) and cluster pools using [Node.js cluster](https://nodejs.org/api/cluster.html) modules.
With poolifier you can improve your **performance** and resolve problems related to the event loop.
Moreover you can execute your tasks using an API designed to improve the **developer experience**.
Please consult our [general guidelines](#general-guidance).
@@ -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 for [multiple 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 }`
@@ -209,7 +209,7 @@ This method will call the terminate method on each worker.
### `class YourWorker extends ThreadWorker/ClusterWorker`
-`fn` (mandatory) The function that you want to execute on the worker
+`taskFunctions` (mandatory) The task function(s) that you want to execute on the worker
`opts` (optional) An object with these properties:
- `maxInactiveTime` (optional) - Max time to wait tasks to work on in milliseconds, after this period the new worker will die.