X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=07bcdb10543cf3f52e0adc755ff3dd2f38459fbb;hb=49be33feded000ed776ee589274e154fa519b263;hp=05865e2cfcecfddae76d46a05eb89a4b139ba2f4;hpb=0feeec4ab35dae438017f69feb1a1a560ea9ffe8;p=poolifier.git
diff --git a/README.md b/README.md
index 05865e2c..07bcdb10 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@
-
+
@@ -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).
@@ -104,8 +104,7 @@ function yourFunction(data) {
}
module.exports = new ThreadWorker(yourFunction, {
- maxInactiveTime: 60000,
- async: false
+ maxInactiveTime: 60000
})
```
@@ -140,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.
@@ -176,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 }`
@@ -210,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.