From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Sun, 9 Jul 2023 20:46:39 +0000 (+0200)
Subject: docs: refine worker node code comments
X-Git-Tag: v2.6.13~8
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;ds=sidebyside;h=ccd73e075194fac1cf6e1b736f1556b199c95bc5;hp=ce1b31beefa0f80927316fc762e5186f823e03c7;p=poolifier.git

docs: refine worker node code comments

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

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 7c4a50c8..055a326a 100644
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -227,46 +227,46 @@ export interface IWorker {
  */
 export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
   /**
-   * Worker node worker.
+   * Worker.
    */
   readonly worker: Worker
   /**
-   * Worker node worker info.
+   * Worker info.
    */
   readonly info: WorkerInfo
   /**
-   * Worker node worker usage statistics.
+   * Worker usage statistics.
    */
   usage: WorkerUsage
   /**
-   * Worker node tasks queue size.
+   * Tasks queue size.
    *
    * @returns The tasks queue size.
    */
   readonly tasksQueueSize: () => number
   /**
-   * Worker node enqueue task.
+   * Enqueue task.
    *
    * @param task - The task to queue.
    * @returns The task queue size.
    */
   readonly enqueueTask: (task: Task<Data>) => number
   /**
-   * Worker node dequeue task.
+   * Dequeue task.
    *
    * @returns The dequeued task.
    */
   readonly dequeueTask: () => Task<Data> | undefined
   /**
-   * Worker node clear tasks queue.
+   * Clears tasks queue.
    */
   readonly clearTasksQueue: () => void
   /**
-   * Worker node reset usage statistics .
+   * Resets usage statistics .
    */
   readonly resetUsage: () => void
   /**
-   * Worker node get task usage statistics.
+   * Gets task usage statistics.
    */
   readonly getTaskWorkerUsage: (name: string) => WorkerUsage | undefined
 }