X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=README.MD;h=7b57162a1b29b28efb9951f54a950f4a80b38c70;hb=1f9a5a440caea7dc60a664d413304250969bb4d8;hp=677199800a85c42a5a6cd9a9a468be1b7ab38524;hpb=ce0b1c1e2e42dc46f72e086a45fafd01433d6ead;p=poolifier.git diff --git a/README.MD b/README.MD index 67719980..7b57162a 100644 --- a/README.MD +++ b/README.MD @@ -2,7 +2,7 @@ [![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) [![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)](https://coveralls.io/github/pioardi/node-thread-pool) +[![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) [![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 @@ -33,7 +33,7 @@ You have to implement your worker extending the ThreadWorker class

Installation

``` -npm install node-thread-pool --save +npm install poolifier --save ```

Usage

@@ -41,7 +41,7 @@ You can implement a worker in a simple way , extending the class ThreadWorker : ```js 'use strict' -const { ThreadWorker } = require('node-pool') +const { ThreadWorker } = require('poolifier') function yourFunction (data) { // this will be executed in the worker thread, @@ -49,19 +49,14 @@ function yourFunction (data) { return { ok: 1 } } -class MyWorker extends ThreadWorker { - constructor () { - super(yourFunction, { maxInactiveTime: 1000 * 60}) - } -} -module.exports = new MyWorker() +module.exports = new ThreadWorker(yourFunction, { maxInactiveTime: 60000 }) ``` -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, @@ -131,10 +126,9 @@ But in general , always profile your application

Contribute

-See guidelines [CONTRIBUTING](./.github/CONTRIBUTING.md) +See guidelines [CONTRIBUTING](CONTRIBUTING.md)

License

[MIT](./LICENSE) -