feat: account tasks wait time more accurately
[poolifier.git] / src / utility-types.ts
index ea90afd688d8622ee2128366c2b3e20d5302977a..cc04f2cb99113b9cb66305c102ae5c8fe88563ad 100644 (file)
@@ -19,7 +19,7 @@ export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
  */
 export interface MessageValue<
   Data = unknown,
-  MainWorker extends ClusterWorker | MessagePort | unknown = unknown
+  MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
 > extends Task<Data> {
   /**
    * Kill code.
@@ -33,6 +33,10 @@ export interface MessageValue<
    * Runtime.
    */
   readonly runTime?: number
+  /**
+   * Wait time.
+   */
+  readonly waitTime?: number
   /**
    * Reference to main worker.
    */
@@ -48,6 +52,7 @@ export interface MessageValue<
 export type WorkerSyncFunction<Data = unknown, Response = unknown> = (
   data?: Data
 ) => Response
+
 /**
  * Worker asynchronous function that can be executed.
  * This function must return a promise.
@@ -58,6 +63,7 @@ export type WorkerSyncFunction<Data = unknown, Response = unknown> = (
 export type WorkerAsyncFunction<Data = unknown, Response = unknown> = (
   data?: Data
 ) => Promise<Response>
+
 /**
  * Worker function that can be executed.
  * This function can be synchronous or asynchronous.
@@ -69,6 +75,20 @@ 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.
  *