Merge branch 'master' into elu-strategy

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index faeda0a5a4e4048ed9c16b5e48d8bdecd4b8c690..bfbc2a84e376ac1db341614f6427943d5405285f 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -11,6 +11,22 @@ import type { IWorker, Task } from './pools/worker'
  */
 export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
 
+/**
+ * Task error.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ */
+export interface TaskError<Data = unknown> {
+  /**
+   * Error message.
+   */
+  message: string
+  /**
+   * Data passed to the worker triggering the error.
+   */
+  data?: Data
+}
+
 /**
  * Task performance.
  */
@@ -23,10 +39,6 @@ export interface TaskPerformance {
    * Task runtime.
    */
   runTime?: number
-  /**
-   * Task wait time.
-   */
-  waitTime?: number
   /**
    * Task event loop utilization.
    */
@@ -38,21 +50,22 @@ export interface TaskPerformance {
  */
 export interface WorkerStatistics {
   runTime: boolean
-  waitTime: boolean
   elu: boolean
 }
 
 /**
  * Message object that is passed between main worker and worker.
  *
+ * @typeParam MessageData - Type of data sent to and/or from the worker. This can only be serializable data.
  * @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<
+  MessageData = unknown,
   Data = unknown,
   MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
-> extends Task<Data> {
+> extends Task<MessageData> {
   /**
    * Kill code.
    */
@@ -60,11 +73,7 @@ export interface MessageValue<
   /**
    * Task error.
    */
-  readonly error?: string
-  /**
-   * Task data triggering task error.
-   */
-  readonly errorData?: unknown
+  readonly taskError?: TaskError<Data>
   /**
    * Task performance.
    */