refactor: cleanup worker usage properties namespace

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

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index ba9393ab9ba8241e5f1a1184165d42055b859835..86f5121dd1d73239c925c51319b6ff8bdc9b2a03 100644 (file)
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -1,4 +1,3 @@
-import type { EventLoopUtilization } from 'node:perf_hooks'
 import type { CircularArray } from '../circular-array'
 import type { Queue } from '../queue'
 
@@ -7,7 +6,7 @@ import type { Queue } from '../queue'
  */
 export type MessageHandler<Worker extends IWorker> = (
   this: Worker,
-  m: unknown
+  message: unknown
 ) => void
 
 /**
@@ -15,7 +14,7 @@ export type MessageHandler<Worker extends IWorker> = (
  */
 export type ErrorHandler<Worker extends IWorker> = (
   this: Worker,
-  e: Error
+  error: Error
 ) => void
 
 /**
@@ -28,13 +27,13 @@ export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
  */
 export type ExitHandler<Worker extends IWorker> = (
   this: Worker,
-  code: number
+  exitCode: number
 ) => void
 
 /**
  * Message object that is passed as a task between main worker and worker.
  *
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @internal
  */
 export interface Task<Data = unknown> {
@@ -63,9 +62,9 @@ export interface Task<Data = unknown> {
  */
 export interface MeasurementStatistics {
   /**
-   * Measurement aggregation.
+   * Measurement aggregate.
    */
-  aggregation: number
+  aggregate: number
   /**
    * Measurement average.
    */
@@ -80,6 +79,17 @@ export interface MeasurementStatistics {
   history: CircularArray<number>
 }
 
+/**
+ * Event loop utilization measurement statistics.
+ *
+ * @internal
+ */
+export interface EventLoopUtilizationMeasurementStatistics {
+  idle: MeasurementStatistics
+  active: MeasurementStatistics
+  utilization: number
+}
+
 /**
  * Task statistics.
  *
@@ -87,19 +97,23 @@ export interface MeasurementStatistics {
  */
 export interface TaskStatistics {
   /**
-   * Number of tasks executed.
+   * Number of executed tasks.
    */
   executed: number
   /**
-   * Number of tasks executing.
+   * Number of executing tasks.
    */
   executing: number
   /**
-   * Number of tasks queued.
+   * Number of queued tasks.
+   */
+  readonly queued: number
+  /**
+   * Maximum number of queued tasks.
    */
-  queued: number
+  readonly maxQueued: number
   /**
-   * Number of tasks failed.
+   * Number of failed tasks.
    */
   failed: number
 }
@@ -123,9 +137,9 @@ export interface WorkerUsage {
    */
   waitTime: MeasurementStatistics
   /**
-   * Event loop utilization.
+   * Tasks event loop utilization statistics.
    */
-  elu: EventLoopUtilization | undefined
+  elu: EventLoopUtilizationMeasurementStatistics
 }
 
 /**
@@ -155,7 +169,7 @@ export interface IWorker {
  * Worker node interface.
  *
  * @typeParam Worker - Type of worker.
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @internal
  */
 export interface WorkerNode<Worker extends IWorker, Data = unknown> {
@@ -166,7 +180,7 @@ export interface WorkerNode<Worker extends IWorker, Data = unknown> {
   /**
    * Worker node worker usage statistics.
    */
-  workerUsage: WorkerUsage
+  usage: WorkerUsage
   /**
    * Worker node tasks queue.
    */