docs: update benchmarks vs. external pools

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index e177adaeb7ccaf8022c338013284201e23ed1ed7..f330d192296dcc62a5b86a4209126d21798acff6 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,15 +1,97 @@
-export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
-
-export type JSONPrimitive = number | boolean | string | null
-// eslint-disable-next-line no-use-before-define
-export type JSONValue = JSONPrimitive | JSONArray | JSONObject
-export type JSONObject = { [k: string]: JSONValue }
-export type JSONArray = Array<JSONValue>
-
-export interface MessageValue<Data = unknown> {
-  readonly data?: Data
-  readonly id?: number
-  readonly kill?: number
-  readonly error?: string
-  readonly parent?: MessagePort
+import type { EventLoopUtilization } from 'node:perf_hooks'
+import type { KillBehavior } from './worker/worker-options'
+import type { IWorker, Task } from './pools/worker'
+
+/**
+ * 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> {
+  /**
+   * Error message.
+   */
+  message: string
+  /**
+   * Data passed to the worker triggering the error.
+   */
+  data?: Data
+}
+
+/**
+ * Task performance.
+ */
+export interface TaskPerformance {
+  /**
+   * Task performance timestamp.
+   */
+  timestamp: number
+  /**
+   * Task runtime.
+   */
+  runTime?: number
+  /**
+   * Task event loop utilization.
+   */
+  elu?: EventLoopUtilization
+}
+
+/**
+ * Performance statistics computation.
+ */
+export interface WorkerStatistics {
+  runTime: boolean
+  elu: boolean
+}
+
+/**
+ * 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 | 1
+  /**
+   * Task error.
+   */
+  readonly taskError?: TaskError<ErrorData>
+  /**
+   * 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 resolve: (value: Response) => void
+  /**
+   * Reject callback to reject the promise.
+   */
+  readonly reject: (reason?: string) => void
+  /**
+   * The worker handling the execution.
+   */
+  readonly worker: Worker
 }