docs: improve backPressure event documentation

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1c61fc49de631077b2b075f052dbce1944d02c25..4e01305023cbd42ab17dbeea693fd3fb46dc16ba 100644 (file)
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -16,7 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add back pressure detection on the worker node queue. Event `backPressure` is emitted all worker node queues are full (worker node queue size >= poolMaxSize^2).
+- Add back pressure detection on the worker node queue. Event `backPressure` is emitted when all worker node queues are full (worker node queue size >= poolMaxSize^2).
 - Use back pressure detection in worker choice strategies.
 - Add worker choice strategies retries mechanism if no worker is eligible.
 

diff --git a/docs/api.md b/docs/api.md
index a48f4c54c3977dadade267f0ef5ca50e3ae22fda..1848c1306016fc9e9a780ba8d712704fe3f6efad 100644 (file)
--- a/docs/api.md
+++ b/docs/api.md
@@ -94,7 +94,8 @@ An object with these properties:
   Properties:
 
   - `concurrency` (optional) - The maximum number of tasks that can be executed concurrently on a worker. It must be a positive integer.
-    Default: `{ concurrency: 1 }`
+
+  Default: `{ concurrency: 1 }`
 
 #### `ThreadPoolOptions extends PoolOptions`
 

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 427dfd1c56f5ff0f60caa61b7aeb8e6c74062935..e65cc115d2d77c0a0590fa5f936043b16dcb38d2 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -201,7 +201,7 @@ export interface IPool<
    * - '`destroy`': Emitted when the pool is destroyed.
    * - `'error'`: Emitted when an uncaught error occurs.
    * - `'taskError'`: Emitted when an error occurs while executing a task.
-   * - `'backPressure'`: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full).
+   * - `'backPressure'`: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size \>= pool maximum size^2).
    */
   readonly emitter?: PoolEmitter
   /**