X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=README.MD;h=7d633922b26fbdf734e7532e554be40f2ce937b0;hb=205146104b51fff3f158d1fab15e26eef6dfb27d;hp=48d6a30f315a9e400b874775c833c1a5cb6c3388;hpb=755f08b3242edeca87f8f3d500e970de097b7851;p=poolifier.git
diff --git a/README.MD b/README.MD
index 48d6a30f..7d633922 100644
--- a/README.MD
+++ b/README.MD
@@ -1,7 +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/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
@@ -11,6 +24,8 @@
·
API
·
+ Choose a pool
+ ·
Contribute
·
Compatibility
@@ -21,12 +36,12 @@
Overview
Node pool contains two worker-threads pool implementations , you don' t have to deal with worker-threads complexity.
The first implementation is a static thread pool , with a defined number of threads that are started at creation time and will be reused.
-The second implementation is a dynamic thread pool with a number of threads started at creation time ( these threads will be always active and reused) and other threads created when the load will increase ( with an upper limit ), the new created threads will be stopped after a configurable period of inactivity.
+The second implementation is a dynamic thread pool with a number of threads started at creation time ( these threads will be always active and reused) and other threads created when the load will increase ( with an upper limit, these threads will be reused when active ), the new created threads will be stopped after a configurable period of inactivity.
You have to implement your worker extending the ThreadWorker class
Installation
```
-npm install node-thread-pool --save
+npm install poolifier --save
```
Usage
@@ -34,33 +49,33 @@ You can implement a worker in a simple way , extending the class ThreadWorker :
```js
'use strict'
-const { ThreadWorker } = require('node-pool')
-
-class MyWorker extends ThreadWorker {
- constructor () {
- super((data) => {
- // this will be executed in the worker thread,
- // the data will be received by using the execute method
- return { ok: 1 }
- }, { maxInactiveTime: 1000 * 60})
- }
+const { ThreadWorker } = require('poolifier')
+
+function yourFunction (data) {
+ // this will be executed in the worker thread,
+ // the data will be received by using the execute method
+ return { ok: 1 }
}
-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'
-const { FixedThreadPool, DynamicThreadPool } = require('node-pool')
+const { FixedThreadPool, DynamicThreadPool } = require('poolifier')
// a fixed thread pool
const pool = new FixedThreadPool(15,
- './yourWorker.js')
+ './yourWorker.js',
+ { errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
// or a dynamic thread pool
const pool = new DynamicThreadPool(10, 100,
- './yourWorker.js')
+ './yourWorker.js',
+ { errorHandler: (e) => console.error(e), onlineHandler: () => console.log('worker is online') })
+
pool.emitter.on('FullPool', () => console.log('Pool is full'))
// the execute method signature is the same for both implementations,
@@ -71,11 +86,12 @@ pool.execute({}).then(res => {
```
- See examples folder for more details.
+ 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 version 10.x with --experimental-worker flag, or you can use an higher version (i.e 12.x)
+You can use node versions 12.x , 13.x, 14.x
API
@@ -107,13 +123,23 @@ 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.
+We already have a bench folder where you can find some comparisons.
+To choose your pool consider that with a FixedThreadPool or a DynamicThreadPool ( in this case is important the min parameter passed to the constructor) your application memory footprint will increase .
+Increasing the memory footprint, your application will be ready to accept more CPU bound tasks, but during idle time your application will consume more memory.
+One good choose from my point of view is to profile your application using Fixed/Dynamic thread pool , and to see your application metrics when you increase/decrease the num of threads.
+For example you could keep the memory footprint low choosing a DynamicThreadPool with 5 threads, and allow to create new threads until 50/100 when needed, this is the advantage to use the DynamicThreadPool.
+But in general , always profile your application
Contribute
-See guidelines [CONTRIBUTING](./.github/CONTRIBUTING.md)
+See guidelines [CONTRIBUTING](CONTRIBUTING.md)
+Choose your task here 2.0.0, propose an idea, a fix, an improvement.
License
[MIT](./LICENSE)
-