X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=28bf19e256abaef2f619051773ad55456643b842;hb=e677f6c55e0bb599d8e589a937a928229ecd6fea;hp=5a3ef4c565f184e5712d2f47f755848a62f3cb42;hpb=325f50bc1777ea44abc9736ce9d780ec0c8f90e2;p=poolifier.git

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 5a3ef4c5..28bf19e2 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,9 +1,146 @@
-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 } from './pools/worker'
 
-export interface MessageValue<Data> {
+/**
+ * Task error.
+ *
+ * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
+ */
+export interface TaskError<Data = unknown> {
+  /**
+   * Task name triggering the error.
+   */
+  readonly name: string
+  /**
+   * Error message.
+   */
+  readonly message: string
+  /**
+   * Data triggering the error.
+   */
   readonly data?: Data
-  readonly id?: number
-  readonly kill?: number
-  readonly error?: string
-  readonly parent?: MessagePort
+}
+
+/**
+ * Task performance.
+ *
+ * @internal
+ */
+export interface TaskPerformance {
+  /**
+   * Task name.
+   */
+  readonly name: string
+  /**
+   * Task performance timestamp.
+   */
+  readonly timestamp: number
+  /**
+   * Task runtime.
+   */
+  readonly runTime?: number
+  /**
+   * Task event loop utilization.
+   */
+  readonly elu?: EventLoopUtilization
+}
+
+/**
+ * Performance statistics computation.
+ *
+ * @internal
+ */
+export interface WorkerStatistics {
+  runTime: boolean
+  elu: boolean
+}
+
+/**
+ * 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 structured-cloneable data.
+ * @internal
+ */
+export interface Task<Data = unknown> {
+  /**
+   * Worker id.
+   */
+  readonly workerId: number
+  /**
+   * Task name.
+   */
+  readonly name?: string
+  /**
+   * Task input data that will be passed to the worker.
+   */
+  readonly data?: Data
+  /**
+   * Timestamp.
+   */
+  readonly timestamp?: number
+  /**
+   * Message UUID.
+   */
+  readonly id?: string
+}
+
+/**
+ * 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, ErrorData = unknown>
+  extends Task<Data> {
+  /**
+   * Kill code.
+   */
+  readonly kill?: KillBehavior | true
+  /**
+   * Task error.
+   */
+  readonly taskError?: TaskError<ErrorData>
+  /**
+   * Task performance.
+   */
+  readonly taskPerformance?: TaskPerformance
+  /**
+   * Whether the worker computes the given statistics or not.
+   */
+  readonly statistics?: WorkerStatistics
+  /**
+   * Whether the worker is ready or not.
+   */
+  readonly ready?: boolean
+  /**
+   * Whether the worker starts or stops its aliveness check.
+   */
+  readonly checkAlive?: boolean
+}
+
+/**
+ * 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 resolve: (value: Response) => void
+  /**
+   * Reject callback to reject the promise.
+   */
+  readonly reject: (reason?: string) => void
+  /**
+   * The worker handling the execution.
+   */
+  readonly worker: Worker
 }