docs: enhance documentation

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 54bb7461f6fa5cafb2cb04270ce732b093d8ce53..685e5c4c606755bf801dd6c13d582d3657f8fe8e 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,6 +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 { IWorker } from './pools/worker'
 
 /**
  * Make all properties in T non-readonly.
@@ -9,6 +10,9 @@ export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
 
 /**
  * Message object that is passed between worker and main worker.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam MainWorker - Type of main worker.
  */
 export interface MessageValue<
   Data = unknown,
@@ -31,13 +35,14 @@ export interface MessageValue<
    */
   readonly error?: string
   /**
-   * Task runtime.
+   * Runtime.
    */
-  readonly taskRunTime?: number
+  readonly runTime?: number
   /**
    * Reference to main worker.
    *
    * Only for internal use.
+   * @internal
    */
   readonly parent?: MainWorker
 }
@@ -45,9 +50,14 @@ export interface MessageValue<
 /**
  * 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 +67,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
 }