chore: v2.4.8

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 05af4e3d396b7c89d22ba0c895ceb6c4649e5f42..e48ded5373695b4f778d43da19f00c2cf5b0ee3f 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,7 +1,7 @@
 import type { Worker as ClusterWorker } from 'node:cluster'
 import type { MessagePort } from 'node:worker_threads'
 import type { KillBehavior } from './worker/worker-options'
-import type { IPoolWorker } from './pools/pool-worker'
+import type { IWorker, Task } from './pools/worker'
 
 /**
  * Make all properties in T non-readonly.
@@ -9,20 +9,16 @@ import type { IPoolWorker } from './pools/pool-worker'
 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
-> {
-  /**
-   * Input data that will be passed to the worker.
-   */
-  readonly data?: Data
-  /**
-   * Id of the message.
-   */
-  readonly id?: string
+> extends Task<Data> {
   /**
    * Kill code.
    */
@@ -39,6 +35,7 @@ export interface MessageValue<
    * Reference to main worker.
    *
    * Only for internal use.
+   * @internal
    */
   readonly parent?: MainWorker
 }
@@ -48,9 +45,10 @@ export interface MessageValue<
  *
  * @typeParam Worker - Type of worker.
  * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @internal
  */
 export interface PromiseResponseWrapper<
-  Worker extends IPoolWorker,
+  Worker extends IWorker,
   Response = unknown
 > {
   /**
@@ -62,7 +60,7 @@ export interface PromiseResponseWrapper<
    */
   readonly reject: (reason?: string) => void
   /**
-   * The worker handling the promise.
+   * The worker handling the execution.
    */
   readonly worker: Worker
 }