test: add multi tasks worker

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 3a454f3e6b8d0e1ee1c3a64897206f04c35c3ef8..331085febb79486a590ed3aff0020eb11b08f02d 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -5,6 +5,8 @@ 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] }
 
@@ -13,6 +15,7 @@ export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
  *
  * @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,
@@ -32,13 +35,56 @@ export interface MessageValue<
   readonly runTime?: number
   /**
    * Reference to main worker.
-   *
-   * Only for internal use.
-   * @internal
    */
   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.
  *