X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=ea90afd688d8622ee2128366c2b3e20d5302977a;hb=cb70b19deb97dc2c8ad1a769e59e870ee37f8e4d;hp=e177adaeb7ccaf8022c338013284201e23ed1ed7;hpb=d3c8a1a8022726094160d1413f1f289c5d84d715;p=poolifier.git

diff --git a/src/utility-types.ts b/src/utility-types.ts
index e177adae..ea90afd6 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,15 +1,95 @@
-export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
+import type { Worker as ClusterWorker } from 'node:cluster'
+import type { MessagePort } from 'node:worker_threads'
+import type { KillBehavior } from './worker/worker-options'
+import type { IWorker, Task } from './pools/worker'
 
-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>
+/**
+ * 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] }
 
-export interface MessageValue<Data = unknown> {
-  readonly data?: Data
-  readonly id?: number
-  readonly kill?: number
+/**
+ * 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
+> extends Task<Data> {
+  /**
+   * Kill code.
+   */
+  readonly kill?: KillBehavior | 1
+  /**
+   * Error.
+   */
   readonly error?: string
-  readonly parent?: MessagePort
+  /**
+   * Runtime.
+   */
+  readonly runTime?: number
+  /**
+   * Reference to main worker.
+   */
+  readonly parent?: MainWorker
+}
+
+/**
+ * Worker synchronous function that can be executed.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
+ */
+export type WorkerSyncFunction<Data = unknown, Response = unknown> = (
+  data?: Data
+) => Response
+/**
+ * Worker asynchronous function that can be executed.
+ * This function must return a promise.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
+ */
+export type WorkerAsyncFunction<Data = unknown, Response = unknown> = (
+  data?: Data
+) => Promise<Response>
+/**
+ * Worker function that can be executed.
+ * This function can be synchronous or asynchronous.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
+ */
+export type WorkerFunction<Data = unknown, Response = unknown> =
+  | WorkerSyncFunction<Data, Response>
+  | WorkerAsyncFunction<Data, Response>
+
+/**
+ * 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 serializable 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
 }