docs: add missing code comments

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

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 26ca4c03279ad9969df3940141cf0bade3b815b4..6f3d9561a158c7815c007a2a2ebf631ee1e163bc 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -191,6 +191,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 a worker node has back pressure (i.e. its tasks queue is full).
    */
   readonly emitter?: PoolEmitter
   /**

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index cd395bbdd0301948937bc7c1ba06d3f2f68d540f..3c44f05eae148883c5c83f91304f894d2297e5fc 100644 (file)
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -257,7 +257,10 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
    */
   readonly closeChannel: () => void
   /**
-   * Gets task worker usage statistics.
+   * Gets task function worker usage statistics.
+   *
+   * @param name - The task function name.
+   * @returns The task function worker usage statistics if the task function worker usage statistics are initialized, `undefined` otherwise.
    */
   readonly getTaskWorkerUsage: (name: string) => WorkerUsage | undefined
 }