X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=926b3280b2f85e4378031cee08b59ce0fee65c98;hb=0f3efafd05a3fa733a0f49c336f42cc61ab52e6a;hp=5a3ef4c565f184e5712d2f47f755848a62f3cb42;hpb=325f50bc1777ea44abc9736ce9d780ec0c8f90e2;p=poolifier.git

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 5a3ef4c5..926b3280 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,9 +1,68 @@
+import type { Worker as ClusterWorker } from 'cluster'
+import type { MessagePort } from 'worker_threads'
+import type { AbstractPoolWorker } from './pools/abstract-pool-worker'
+import type { KillBehavior } from './worker/worker-options'
+
+/**
+ * Make all properties in T non-readonly.
+ */
 export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
 
-export interface MessageValue<Data> {
+/**
+ * Message object that is passed between worker and main worker.
+ */
+export interface MessageValue<
+  Data = unknown,
+  MainWorker extends ClusterWorker | MessagePort | unknown = unknown
+> {
+  /**
+   * Input data that will be passed to the worker.
+   */
   readonly data?: Data
+  /**
+   * Id of the message.
+   */
   readonly id?: number
-  readonly kill?: number
+  /**
+   * Kill code.
+   */
+  readonly kill?: KillBehavior | 1
+  /**
+   * Error.
+   */
   readonly error?: string
-  readonly parent?: MessagePort
+  /**
+   * Task runtime.
+   */
+  readonly taskRunTime?: number
+  /**
+   * Reference to main worker.
+   *
+   * Only for internal use.
+   */
+  readonly parent?: MainWorker
+}
+
+/**
+ * An object holding the worker that will be used to resolve/rejects the promise later on.
+ *
+ * @template Worker Type of worker.
+ * @template Response Type of response of execution. This can only be serializable data.
+ */
+export interface PromiseWorkerResponseWrapper<
+  Worker extends AbstractPoolWorker,
+  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 that has the assigned task.
+   */
+  readonly worker: Worker
 }