From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Wed, 7 Jun 2023 22:16:54 +0000 (+0200)
Subject: docs: add type definition documentation
X-Git-Tag: v2.6.0~18
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;ds=sidebyside;h=213e817d69db5ac80137ef59ed5cdadcde4d73cf;hp=-c;p=poolifier.git

docs: add type definition documentation

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

213e817d69db5ac80137ef59ed5cdadcde4d73cf
diff --git a/src/utility-types.ts b/src/utility-types.ts
index 10b8eda1..57ff0003 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -11,6 +11,11 @@ import type { IWorker, Task } from './pools/worker'
  */
 export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
 
+/**
+ * Task error.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ */
 export interface TaskError<Data = unknown> {
   /**
    * Error message.