Merge pull request #770 from poolifier/elu-strategy

[poolifier.git] / src / utility-types.ts

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 3a454f3e6b8d0e1ee1c3a64897206f04c35c3ef8..9cdf6b0a7e82f9d1e3da5fb434537ca8e2d943f9 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,42 +1,68 @@
 import type { Worker as ClusterWorker } from 'node:cluster'
 import type { MessagePort } from 'node:worker_threads'
+import type { EventLoopUtilization } from 'node:perf_hooks'
 import type { KillBehavior } from './worker/worker-options'
 import type { IWorker, Task } from './pools/worker'
 
 /**
  * Make all properties in T non-readonly.
+ *
+ * @typeParam T - Type in which properties will be non-readonly.
  */
 export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
 
+/**
+ * Performance statistics computation.
+ */
+export interface WorkerStatistics {
+  runTime: boolean
+  waitTime: boolean
+  elu: boolean
+}
+
 /**
  * Message object that is passed between main worker and worker.
  *
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
  * @typeParam MainWorker - Type of main worker.
+ * @internal
  */
 export interface MessageValue<
   Data = unknown,
-  MainWorker extends ClusterWorker | MessagePort | unknown = unknown
+  MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
 > extends Task<Data> {
   /**
    * Kill code.
    */
   readonly kill?: KillBehavior | 1
   /**
-   * Error.
+   * Task error.
    */
   readonly error?: string
+  /**
+   * Task data triggering task error.
+   */
+  readonly errorData?: unknown
   /**
    * Runtime.
    */
   readonly runTime?: number
+  /**
+   * Wait time.
+   */
+  readonly waitTime?: number
+  /**
+   * Event loop utilization.
+   */
+  readonly elu?: EventLoopUtilization
   /**
    * Reference to main worker.
-   *
-   * Only for internal use.
-   * @internal
    */
   readonly parent?: MainWorker
+  /**
+   * Whether to compute the given statistics or not.
+   */
+  readonly statistics?: WorkerStatistics
 }
 
 /**