refactor: add task function name to task performance

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

diff --git a/src/pools/worker-node.ts b/src/pools/worker-node.ts
index a493b65ded97c3651076a21a244fd41fe3ce8620..bbca79135b5d7cb3df575abccebd70c0719296f2 100644 (file)
--- a/src/pools/worker-node.ts
+++ b/src/pools/worker-node.ts
@@ -10,6 +10,12 @@ import {
   type WorkerUsage
 } from './worker'
 
+/**
+ * Worker node.
+ *
+ * @typeParam Worker - Type of worker.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ */
 export class WorkerNode<Worker extends IWorker, Data = unknown>
 implements IWorkerNode<Worker, Data> {
   public readonly worker: Worker
@@ -17,6 +23,12 @@ implements IWorkerNode<Worker, Data> {
   public usage: WorkerUsage
   private readonly tasksQueue: Queue<Task<Data>>
 
+  /**
+   * Constructs a new worker node.
+   *
+   * @param worker - The worker.
+   * @param workerType - The worker type.
+   */
   constructor (worker: Worker, workerType: WorkerType) {
     this.worker = worker
     this.info = this.initWorkerInfo(worker, workerType)
@@ -62,7 +74,7 @@ implements IWorkerNode<Worker, Data> {
       id: this.getWorkerId(worker, workerType),
       type: workerType,
       dynamic: false,
-      started: true
+      ready: false
     }
   }
 
@@ -70,7 +82,7 @@ implements IWorkerNode<Worker, Data> {
     const getTasksQueueSize = (): number => {
       return this.tasksQueueSize()
     }
-    const getTasksMaxQueueSize = (): number => {
+    const getTasksQueueMaxSize = (): number => {
       return this.tasksQueueMaxSize()
     }
     return {
@@ -81,7 +93,7 @@ implements IWorkerNode<Worker, Data> {
           return getTasksQueueSize()
         },
         get maxQueued (): number {
-          return getTasksMaxQueueSize()
+          return getTasksQueueMaxSize()
         },
         failed: 0
       },
@@ -106,6 +118,7 @@ implements IWorkerNode<Worker, Data> {
    * Gets the worker id.
    *
    * @param worker - The worker.
+   * @param workerType - The worker type.
    * @returns The worker id.
    */
   private getWorkerId (