Initial comment conversion to TSDoc

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 9441fec4e420292905a23150d73580e73b3411cd..2d142f860e4b19893a131e7cbc872abda5f8270a 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,6 +1,6 @@
-import type { Worker } from 'cluster'
+import type { Worker as ClusterWorker } from 'cluster'
 import type { MessagePort } from 'worker_threads'
-import type { IWorker } from './pools/abstract-pool'
+import type { IPoolWorker } from './pools/pool-worker'
 import type { KillBehavior } from './worker/worker-options'
 
 /**
@@ -13,14 +13,14 @@ export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
  */
 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
   /**
@@ -31,10 +31,14 @@ export interface MessageValue<
    * Error.
    */
   readonly error?: string
+  /**
+   * Task runtime.
+   */
+  readonly taskRunTime?: number
   /**
    * Reference to main worker.
    *
-   * _Only for internal use_
+   * Only for internal use.
    */
   readonly parent?: MainWorker
 }
@@ -42,11 +46,11 @@ export interface MessageValue<
 /**
  * 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.
+ * @typeParam Worker - Type of worker.
+ * @typeParam Response - Type of response of execution. This can only be serializable data.
  */
 export interface PromiseWorkerResponseWrapper<
-  Worker extends IWorker,
+  Worker extends IPoolWorker,
   Response = unknown
 > {
   /**