docs: improve backPressure event documentation
[poolifier.git] / src / pools / pool.ts
index 427dfd1c56f5ff0f60caa61b7aeb8e6c74062935..e65cc115d2d77c0a0590fa5f936043b16dcb38d2 100644 (file)
@@ -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
   /**