From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Thu, 13 Apr 2023 13:28:12 +0000 (+0200)
Subject: docs: enhance types documentation
X-Git-Tag: v2.4.9~32
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=b40ed51168059b59f6f5827def37f622be139ddb;p=poolifier.git

docs: enhance types documentation

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
---

diff --git a/src/utility-types.ts b/src/utility-types.ts
index e48ded53..fb0e435a 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -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] }
 
@@ -33,9 +35,6 @@ export interface MessageValue<
   readonly runTime?: number
   /**
    * Reference to main worker.
-   *
-   * Only for internal use.
-   * @internal
    */
   readonly parent?: MainWorker
 }