docs: enhance types documentation
authorJérôme Benoit <jerome.benoit@sap.com>
Thu, 13 Apr 2023 13:28:12 +0000 (15:28 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Thu, 13 Apr 2023 13:28:12 +0000 (15:28 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
src/utility-types.ts

index e48ded5373695b4f778d43da19f00c2cf5b0ee3f..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] }
 
@@ -33,9 +35,6 @@ export interface MessageValue<
   readonly runTime?: number
   /**
    * Reference to main worker.
-   *
-   * Only for internal use.
-   * @internal
    */
   readonly parent?: MainWorker
 }