X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=47a680d039609442639275395e62b5b699a540cb;hb=bdb9d7125f62a36dd65cba6aa9110ce269359f0a;hp=4c247c6363fe40d9627f47388a7f541e7fd82aee;hpb=d0ed34c9a6f9896c16b1b963e87217bbf75f3393;p=poolifier.git diff --git a/README.md b/README.md index 4c247c63..47a680d0 100644 --- a/README.md +++ b/README.md @@ -40,11 +40,16 @@ Please consult our [general guidelines](#general-guidelines). - Easy switch from a pool type to another :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 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 multiple task functions :white_check_mark: -- Support sync and async task functions :white_check_mark: +- Support for multiple task functions :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: + - Tasks stealing under back pressure :white_check_mark: + - Tasks redistribution on worker error :white_check_mark: - General guidelines on pool choice :white_check_mark: - Error handling out of the box :white_check_mark: - Widely tested :white_check_mark: @@ -62,7 +67,7 @@ Please consult our [general guidelines](#general-guidelines). - [Overview](#overview) - [Installation](#installation) - [Usage](#usage) -- [Node versions](#node-versions) +- [Node.js versions](#nodejs-versions) - [API](#api) - [General guidelines](#general-guidelines) - [Worker choice strategies](#worker-choice-strategies) @@ -128,7 +133,7 @@ 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 easy switch from one to another +// so you can easily switch from one to another pool .execute() .then((res) => { @@ -141,7 +146,7 @@ pool You can do the same with the classes _ClusterWorker_, _FixedClusterPool_ and _DynamicClusterPool_. -**See [examples](./examples/) folder for more details**: +**See [examples](./examples/) for more details**: - [Javascript](./examples/javascript/) - [Typescript](./examples/typescript/) @@ -161,9 +166,9 @@ You can do the same with the classes _ClusterWorker_, _FixedClusterPool_ and _Dy Remember that workers can only send and receive structured-cloneable data. -## Node versions +## Node.js versions -Node versions >= 16.14.x are supported. +Node.js versions >= 16.14.x are supported. ## [API](./docs/api.md)