X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=21a442538d4988eba011f7904b2467cc895c3593;hb=8881ae32256c9a9ebe6d78c95672f610a3f46719;hp=54bb7461f6fa5cafb2cb04270ce732b093d8ce53;hpb=2740a743fcbf64e0ee674530e3cbcf6df710c1ef;p=poolifier.git

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 54bb7461..21a44253 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,53 +1,109 @@
 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'
 
 /**
  * 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] }
 
 /**
- * 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. This can only be serializable data.
+ * @typeParam MainWorker - Type of main worker.
+ * @internal
  */
 export interface MessageValue<
   Data = unknown,
-  MainWorker extends ClusterWorker | MessagePort | unknown = unknown
-> {
+  MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
+> 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?: string
+  readonly error?: string
   /**
-   * Kill code.
+   * Task data triggering task error.
    */
-  readonly kill?: KillBehavior | 1
+  readonly errorData?: unknown
   /**
-   * Error.
+   * Runtime.
    */
-  readonly error?: string
+  readonly runTime?: number
   /**
-   * Task runtime.
+   * Wait time.
    */
-  readonly taskRunTime?: number
+  readonly waitTime?: number
   /**
    * Reference to main worker.
-   *
-   * Only for internal use.
    */
   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>
+
+/**
+ * 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 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<Response = unknown> {
+export interface PromiseResponseWrapper<
+  Worker extends IWorker,
+  Response = unknown
+> {
   /**
    * Resolve callback to fulfill the promise.
    */
@@ -57,7 +113,7 @@ export interface PromiseResponseWrapper<Response = unknown> {
    */
   readonly reject: (reason?: string) => void
   /**
-   * The worker handling the promise key .
+   * The worker handling the execution.
    */
-  readonly workerKey: number
+  readonly worker: Worker
 }