X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=660152cf364fb689eeeb6343af15677fd206c2a0;hb=929275492f8749a7ecab9cbe4bee2eabb94cbf23;hp=5ef4138540626b3bc523fbfa9e2277fedbc2d91a;hpb=8ccfa7d88f7fcfa93b1e826f31cc92d7bf288e80;p=poolifier.git diff --git a/README.md b/README.md index 5ef41385..660152cf 100644 --- a/README.md +++ b/README.md @@ -2,30 +2,26 @@ -

Node.js Worker_Threads and Cluster Worker Pool

- -

- - GitHub commit activity (master) - - Weekly Downloads - - Actions Status - - Code Coverage - - Quality Gate Status - - Javascript Standard Style Guide - - Gitter chat - - Open Collective - - PR Welcome - - No dependencies -

+
+ +# Node.js Worker_Threads and Cluster Worker Pool + +
+ +
+ +[![GitHub commit activity (master)](https://img.shields.io/github/commit-activity/m/poolifier/poolifier/master?color=brightgreen&logo=github)](https://github.com/poolifier/poolifier/graphs/commit-activity) +[![Weekly Downloads](https://badgen.net/npm/dw/poolifier?icon=npm)](https://www.npmjs.com/package/poolifier) +[![CI Workflow](https://github.com/poolifier/poolifier/actions/workflows/ci.yml/badge.svg)](https://github.com/poolifier/poolifier/actions/workflows/ci.yml) +[![Code Coverage](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=coverage)](https://sonarcloud.io/dashboard?id=pioardi_poolifier) +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=pioardi_poolifier&metric=alert_status)](https://sonarcloud.io/dashboard?id=pioardi_poolifier) +[![Javascript Standard Style Guide]()](https://standardjs.com) +[![Discord](https://badgen.net/discord/online-members/vXxZhyb3b6?icon=discord&label=discord&color=green)](https://discord.gg/vXxZhyb3b6) +[![Open Collective](https://opencollective.com/poolifier/tiers/badge.svg)](https://opencollective.com/poolifier) +[![PRs Welcome](https://badgen.net/static/PRs/welcome/green)](http://makeapullrequest.com) +[![No Dependencies]()]() + +
## Why Poolifier? @@ -40,14 +36,15 @@ Please consult our [general guidelines](#general-guidelines). - Performance [benchmarks](./benchmarks/README.md) :white_check_mark: - No runtime dependencies :white_check_mark: - Proper integration with Node.js [async_hooks](https://nodejs.org/api/async_hooks.html) :white_check_mark: -- Support for CommonJS, ESM, and TypeScript :white_check_mark: +- Support for CommonJS, ESM and TypeScript :white_check_mark: - Support for [worker_threads](https://nodejs.org/api/worker_threads.html) and [cluster](https://nodejs.org/api/cluster.html) Node.js modules :white_check_mark: - Support for multiple task functions :white_check_mark: +- Support for task functions [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) operations at runtime :white_check_mark: - Support for sync and async task functions :white_check_mark: - Tasks distribution strategies :white_check_mark: - Lockless tasks queueing :white_check_mark: - Queued tasks rescheduling: - - Task stealing :white_check_mark: + - Task stealing on empty queue :white_check_mark: - Tasks stealing under back pressure :white_check_mark: - Tasks redistribution on worker error :white_check_mark: - General guidelines on pool choice :white_check_mark: @@ -119,8 +116,8 @@ const pool = new FixedThreadPool(availableParallelism(), './yourWorker.js', { onlineHandler: () => console.info('worker is online') }) -pool.emitter.on(PoolEvents.ready, () => console.info('Pool is ready')) -pool.emitter.on(PoolEvents.busy, () => console.info('Pool is busy')) +pool.emitter?.on(PoolEvents.ready, () => console.info('Pool is ready')) +pool.emitter?.on(PoolEvents.busy, () => console.info('Pool is busy')) // or a dynamic worker_threads pool const pool = new DynamicThreadPool(Math.floor(availableParallelism() / 2), availableParallelism(), './yourWorker.js', { @@ -128,9 +125,9 @@ const pool = new DynamicThreadPool(Math.floor(availableParallelism() / 2), avail onlineHandler: () => console.info('worker is online') }) -pool.emitter.on(PoolEvents.full, () => console.info('Pool is full')) -pool.emitter.on(PoolEvents.ready, () => console.info('Pool is ready')) -pool.emitter.on(PoolEvents.busy, () => console.info('Pool is busy')) +pool.emitter?.on(PoolEvents.full, () => console.info('Pool is full')) +pool.emitter?.on(PoolEvents.ready, () => console.info('Pool is ready')) +pool.emitter?.on(PoolEvents.busy, () => console.info('Pool is busy')) // the execute method signature is the same for both implementations, // so you can easily switch from one to another