fix: fix back pressure detection

[poolifier.git] / src / pools / worker.ts

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index cd395bbdd0301948937bc7c1ba06d3f2f68d540f..1d0c4e22e47f073384bdf8c69e3c477ea9cb1d2b 100644 (file)
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -229,7 +229,7 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
    * Enqueue task.
    *
    * @param task - The task to queue.
-   * @returns The task queue size.
+   * @returns The tasks queue size.
    */
   readonly enqueueTask: (task: Task<Data>) => number
   /**
@@ -243,13 +243,13 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
    */
   readonly clearTasksQueue: () => void
   /**
-   * Whether the worker node has back pressure.
+   * Whether the worker node has back pressure (i.e. its tasks queue is full).
    *
    * @returns `true` if the worker node has back pressure, `false` otherwise.
    */
   readonly hasBackPressure: () => boolean
   /**
-   * Resets usage statistics .
+   * Resets usage statistics.
    */
   readonly resetUsage: () => void
   /**
@@ -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
+  readonly getTaskFunctionWorkerUsage: (name: string) => WorkerUsage | undefined
 }