X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=f330d192296dcc62a5b86a4209126d21798acff6;hb=25f5b5de1c522d29f7a16597245a2f7c9434b124;hp=aa4d058cce142ffa5214c8d2ce2965e428309d14;hpb=729c563db85562dd7d0f7733b1a3e2d98467134b;p=poolifier.git

diff --git a/src/utility-types.ts b/src/utility-types.ts
index aa4d058c..f330d192 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,50 +1,97 @@
-/**
- * Make all properties in T non-readonly
- */
-export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
+import type { EventLoopUtilization } from 'node:perf_hooks'
+import type { KillBehavior } from './worker/worker-options'
+import type { IWorker, Task } from './pools/worker'
 
 /**
- * Serializable primitive JSON value.
- */
-export type JSONPrimitive = number | boolean | string | null
-/**
- * Serializable JSON value.
+ * Task error.
+ *
+ * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
  */
-// eslint-disable-next-line no-use-before-define
-export type JSONValue = JSONPrimitive | JSONArray | JSONObject
+export interface TaskError<Data = unknown> {
+  /**
+   * Error message.
+   */
+  message: string
+  /**
+   * Data passed to the worker triggering the error.
+   */
+  data?: Data
+}
+
 /**
- * Serializable JSON object.
+ * Task performance.
  */
-export type JSONObject = { [k: string]: JSONValue }
+export interface TaskPerformance {
+  /**
+   * Task performance timestamp.
+   */
+  timestamp: number
+  /**
+   * Task runtime.
+   */
+  runTime?: number
+  /**
+   * Task event loop utilization.
+   */
+  elu?: EventLoopUtilization
+}
+
 /**
- * Serializable JSON array.
+ * Performance statistics computation.
  */
-export type JSONArray = Array<JSONValue>
+export interface WorkerStatistics {
+  runTime: boolean
+  elu: boolean
+}
 
 /**
- * Message object that is passed between worker and main worker.
+ * Message object that is passed between main worker and worker.
+ *
+ * @typeParam Data - Type of data sent to the worker or execution response. This can only be structured-cloneable data.
+ * @typeParam ErrorData - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
+ * @internal
  */
-export interface MessageValue<Data = unknown> {
+export interface MessageValue<Data = unknown, ErrorData = unknown>
+  extends Task<Data> {
   /**
-   * Input data that will be passed to the worker.
+   * Kill code.
    */
-  readonly data?: Data
+  readonly kill?: KillBehavior | 1
   /**
-   * ID of the message.
+   * Task error.
    */
-  readonly id?: number
+  readonly taskError?: TaskError<ErrorData>
   /**
-   * Kill code.
+   * Task performance.
+   */
+  readonly taskPerformance?: TaskPerformance
+  /**
+   * Whether to compute the given statistics or not.
+   */
+  readonly statistics?: WorkerStatistics
+}
+
+/**
+ * An object holding the execution response promise resolve/reject callbacks.
+ *
+ * @typeParam Worker - Type of worker.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @internal
+ */
+export interface PromiseResponseWrapper<
+  Worker extends IWorker,
+  Response = unknown
+> {
+  /**
+   * Resolve callback to fulfill the promise.
    */
-  readonly kill?: number
+  readonly resolve: (value: Response) => void
   /**
-   * Error.
+   * Reject callback to reject the promise.
    */
-  readonly error?: string
+  readonly reject: (reason?: string) => void
   /**
-   * Reference to main worker.
-   *
-   * _Only for internal use_
+   * The worker handling the execution.
    */
-  readonly parent?: MessagePort
+  readonly worker: Worker
 }