X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.MD;h=465ab8d9a236c24871e8743bbab13bb578136ec2;hb=776419ad922294f825dbaf8d1b55595d3706d102;hp=7b57162a1b29b28efb9951f54a950f4a80b38c70;hpb=1f9a5a440caea7dc60a664d413304250969bb4d8;p=poolifier.git
diff --git a/README.MD b/README.MD
index 7b57162a..465ab8d9 100644
--- a/README.MD
+++ b/README.MD
@@ -1,12 +1,20 @@
# Node Thread Pool :arrow_double_up: :on:
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![Dependabot](https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot)](https://badgen.net/dependabot/dependabot/dependabot-core/?icon=dependabot)
+[![npm w](https://img.shields.io/npm/dw/poolifier)](https://www.npmjs.com/package/poolifier)
[![Actions Status](https://github.com/pioardi/node-pool/workflows/NodeCI/badge.svg)](https://github.com/pioardi/node-pool/actions)
-[![Coverage Status](https://coveralls.io/repos/github/pioardi/node-thread-pool/badge.svg?branch=master)](https://coveralls.io/github/pioardi/node-thread-pool?branch=master)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+[![Coverage Status](https://coveralls.io/repos/github/pioardi/poolifier/badge.svg?branch=master)](https://coveralls.io/github/pioardi/poolifier?branch=master)[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![NODEP](https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen
)](https://img.shields.io/static/v1?label=dependencies&message=no%20dependencies&color=brightgreen
)
+[![Gitter](https://badges.gitter.im/poolifier/community.svg)](https://gitter.im/poolifier/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+
+
Why Poolifier?
+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 worker-threads .
+With poolifier you can improve your performance and resolve problems related to the event loop.
+Moreover you can execute your CPU tasks using an API designed to improve the developer experience.
+
+
Contents
@@ -20,6 +28,8 @@
·
Contribute
·
+ Team
+ ·
Compatibility
·
License
@@ -37,7 +47,7 @@ npm install poolifier --save
```
Usage
-You can implement a worker in a simple way , extending the class ThreadWorker :
+You can implement a worker in a simple way , extending the class ThreadWorker :
```js
'use strict'
@@ -49,7 +59,7 @@ function yourFunction (data) {
return { ok: 1 }
}
-module.exports = new ThreadWorker(yourFunction, { maxInactiveTime: 60000 })
+module.exports = new ThreadWorker(yourFunction, { maxInactiveTime: 60000, async: false })
```
Instantiate your pool based on your needed :
@@ -74,15 +84,16 @@ pool.emitter.on('FullPool', () => console.log('Pool is full'))
// so you can easy switch from one to another
pool.execute({}).then(res => {
console.log(res)
-}).catch ....
+}).catch ....
```
- See examples folder for more details ( in particular if you want to use a pool for [multiple functions](./examples/multiFunctionExample.js) ).
+ See examples folder for more details( in particular if you want to use a pool for [multiple functions](./examples/multiFunctionExample.js) ).
+Now type script is also supported, find how to use it into the example folder
Node versions
-You can use node versions 12.x , 13.x
+You can use node versions 12.x , 13.x, 14.x
API
@@ -114,6 +125,7 @@ This method will call the terminate method on each worker.
`fn` (mandatory) The function that you want to execute on the worker thread
`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
Choose your pool
Performance is one of the main target of these thread pool implementations, we want to have a strong focus on this.
@@ -126,8 +138,21 @@ But in general , always profile your application
Contribute
-See guidelines [CONTRIBUTING](CONTRIBUTING.md)
+See guidelines [CONTRIBUTING](CONTRIBUTING.md)
+Choose your task here 2.0.0, propose an idea, a fix, an improvement.
+
+
+Team
+
+
+
+
+**Creator/Owner:**
+* [__Alessandro Pio Ardizio__](https://github.com/pioardi)
+***Contributors***
+* [__Shinigami92__](https://github.com/Shinigami92)
+* [__Jérôme Benoit__](https://github.com/jerome-benoit)
License