X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=08861ebd30045ae430de21eae055f9634a007341;hb=dab8c377b70fc962ec217f2aeb719842f9f94cd6;hp=2a2c1993c46b1d378ae23f78138c6e87f0fd9f16;hpb=3d15e8a7b08e6bbe8265793d0fd859d3113c4f4b;p=poolifier.git

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 2a2c1993..08861ebd 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,57 +1,111 @@
-import type { Worker } from 'cluster'
-import type { MessagePort } from 'worker_threads'
+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 KillBehavior = 'HARD' | 'SOFT'
 /**
- * Make all properties in T non-readonly
+ * 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] }
 
 /**
- * Serializable primitive JSON value.
+ * 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 type JSONPrimitive = number | boolean | string | null
+export interface MessageValue<
+  Data = unknown,
+  MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
+> extends Task<Data> {
+  /**
+   * Kill code.
+   */
+  readonly kill?: KillBehavior | 1
+  /**
+   * Error.
+   */
+  readonly error?: string
+  /**
+   * Runtime.
+   */
+  readonly runTime?: number
+  /**
+   * Reference to main worker.
+   */
+  readonly parent?: MainWorker
+}
+
 /**
- * Serializable JSON value.
+ * 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.
  */
-// eslint-disable-next-line no-use-before-define
-export type JSONValue = JSONPrimitive | JSONArray | JSONObject
+export type WorkerSyncFunction<Data = unknown, Response = unknown> = (
+  data?: Data
+) => Response
+
 /**
- * Serializable JSON object.
+ * 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 JSONObject = { [k: string]: JSONValue }
+export type WorkerAsyncFunction<Data = unknown, Response = unknown> = (
+  data?: Data
+) => Promise<Response>
+
 /**
- * Serializable JSON array.
+ * 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 JSONArray = Array<JSONValue>
+export type WorkerFunction<Data = unknown, Response = unknown> =
+  | WorkerSyncFunction<Data, Response>
+  | WorkerAsyncFunction<Data, Response>
 
 /**
- * Message object that is passed between worker and main worker.
+ * Worker functions that can be executed.
+ * This object can contain synchronous or asynchronous functions.
+ * The key is the name of the function.
+ * The value is the function itself.
+ *
+ * @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 interface MessageValue<
-  Data = unknown,
-  MainWorker extends Worker | MessagePort | unknown = unknown
+export type TaskFunctions<Data = unknown, Response = unknown> = Record<
+string,
+WorkerFunction<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
 > {
   /**
-   * Input data that will be passed to the worker.
-   */
-  readonly data?: Data
-  /**
-   * ID of the message.
-   */
-  readonly id?: number
-  /**
-   * Kill code.
+   * Resolve callback to fulfill the promise.
    */
-  readonly kill?: KillBehavior | 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?: MainWorker
+  readonly worker: Worker
 }