docs: enhance documentation

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 9441fec4e420292905a23150d73580e73b3411cd..685e5c4c606755bf801dd6c13d582d3657f8fe8e 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,7 +1,7 @@
-import type { Worker } from 'cluster'
-import type { MessagePort } from 'worker_threads'
-import type { IWorker } from './pools/abstract-pool'
+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.
@@ -10,19 +10,22 @@ 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,
-  MainWorker extends Worker | MessagePort | unknown = unknown
+  MainWorker extends ClusterWorker | MessagePort | unknown = unknown
 > {
   /**
    * Input data that will be passed to the worker.
    */
   readonly data?: Data
   /**
-   * ID of the message.
+   * Id of the message.
    */
-  readonly id?: number
+  readonly id?: string
   /**
    * Kill code.
    */
@@ -31,21 +34,27 @@ export interface MessageValue<
    * Error.
    */
   readonly error?: string
+  /**
+   * Runtime.
+   */
+  readonly runTime?: number
   /**
    * Reference to main worker.
    *
-   * _Only for internal use_
+   * Only for internal use.
+   * @internal
    */
   readonly parent?: MainWorker
 }
 
 /**
- * An object holding the worker that will be used to resolve/rejects the promise later on.
+ * An object holding the execution response promise resolve/reject callbacks.
  *
- * @template Worker Type of worker.
- * @template Response Type of response of execution. This can only be serializable data.
+ * @typeParam Worker - Type of worker.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @internal
  */
-export interface PromiseWorkerResponseWrapper<
+export interface PromiseResponseWrapper<
   Worker extends IWorker,
   Response = unknown
 > {
@@ -58,7 +67,7 @@ export interface PromiseWorkerResponseWrapper<
    */
   readonly reject: (reason?: string) => void
   /**
-   * The worker that has the assigned task.
+   * The worker handling the execution.
    */
   readonly worker: Worker
 }