docs: align methods signature namespace
[poolifier.git] / src / utility-types.ts
index 3a454f3e6b8d0e1ee1c3a64897206f04c35c3ef8..fb0e435a81ac949b0b82740f1b17c1561bd9d762 100644 (file)
@@ -5,6 +5,8 @@ import type { IWorker, Task } from './pools/worker'
 
 /**
  * Make all properties in T non-readonly.
+ *
+ * @typeParam T - Type in which properties will be non-readonly.
  */
 export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
 
@@ -13,6 +15,7 @@ export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
  *
  * @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,
@@ -32,9 +35,6 @@ export interface MessageValue<
   readonly runTime?: number
   /**
    * Reference to main worker.
-   *
-   * Only for internal use.
-   * @internal
    */
   readonly parent?: MainWorker
 }