)](https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen
)
+<h2>Why Poolifier? </h2>
+Poolifier is used to perform heavy CPU bound tasks on nodejs servers, it implements thread pools ( yes, more thread pool implementations, so you can choose which one fit better for you ) using <a href="https://nodejs.org/api/worker_threads.html#worker_threads_worker_threads">worker-threads </a>.<br>
+With poolifier you can improve your <strong>performance</strong> and resolve problems related to the event loop.<br>
+Moreover you can execute your CPU tasks using an API designed to improve the <strong>developer experience</strong>.
+
+
+
<h2>Contents </h2>
<h3 align="center">
<a href="#installation">Installation</a>
<h2 id="installation">Installation</h2>
```
-npm install @pioardi/node-thread-pool --save
+npm install poolifier --save
```
<h2 id="usage">Usage</h2>
return { ok: 1 }
}
-class MyWorker extends ThreadWorker {
- constructor () {
- super(yourFunction, { maxInactiveTime: 1000 * 60})
- }
-}
-module.exports = new MyWorker()
+module.exports = new ThreadWorker(yourFunction, { maxInactiveTime: 60000, async: false })
```
-Instantiate your pool based on your needed :
+Instantiate your pool based on your needed :
```js
'use strict'
<h2 id="nv">Node versions</h2>
-You can use node versions 12.x , 13.x <br>
+You can use node versions 12.x , 13.x, 14.x <br>
<h2 id="api">API</h2>
`fn` (mandatory) The function that you want to execute on the worker thread <br>
`opts` (optional) An object with these properties :
- `maxInactiveTime` - Max time to wait tasks to work on ( in ms) , after this period the new worker threads will die.
+- `async` - true/false , true if your function contains async pieces else false
<h2 id="cyp">Choose your pool</h2>
Performance is one of the main target of these thread pool implementations, we want to have a strong focus on this.<br>
<h2 id="contribute">Contribute</h2>
-See guidelines [CONTRIBUTING](./.github/CONTRIBUTING.md)
+See guidelines [CONTRIBUTING](CONTRIBUTING.md) <br>
+Choose your task here <a href="https://github.com/pioardi/poolifier/projects/1"> 2.0.0</a>, propose an idea, a fix, an improvement. <br>
<h2 id="license">License</h2>
[MIT](./LICENSE)
-