X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=9cdf6b0a7e82f9d1e3da5fb434537ca8e2d943f9;hb=a788de39a01b042deb0707c2e92af99181b933d2;hp=458b31a055ef7d4a92e86bd9f9fbd1be46512d80;hpb=f06e48d8e14dcfe3277bd16b1bd2463136af13e6;p=poolifier.git

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 458b31a0..9cdf6b0a 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,46 +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 } from './pools/worker'
+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] }
 
 /**
- * Message object that is passed between worker and main worker.
+ * 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
-> {
-  /**
-   * Input data that will be passed to the worker.
-   */
-  readonly data?: Data
-  /**
-   * Id of the message.
-   */
-  readonly id?: string
+  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.
    */
   readonly parent?: MainWorker
+  /**
+   * Whether to compute the given statistics or not.
+   */
+  readonly statistics?: WorkerStatistics
 }
 
 /**
@@ -48,6 +70,7 @@ export interface MessageValue<
  *
  * @typeParam Worker - Type of worker.
  * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @internal
  */
 export interface PromiseResponseWrapper<
   Worker extends IWorker,
@@ -62,7 +85,7 @@ export interface PromiseResponseWrapper<
    */
   readonly reject: (reason?: string) => void
   /**
-   * The worker handling the promise.
+   * The worker handling the execution.
    */
   readonly worker: Worker
 }