From 213e817d69db5ac80137ef59ed5cdadcde4d73cf Mon Sep 17 00:00:00 2001
From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= <jerome.benoit@sap.com>
Date: Thu, 8 Jun 2023 00:16:54 +0200
Subject: [PATCH] docs: add type definition documentation
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
---
 src/utility-types.ts | 5 +++++
 1 file changed, 5 insertions(+)

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.
-- 
2.34.1