docs: add documentation to worker function type aliases

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 81a57698f5fa6a7dc5e631cbdec844ee68c44c2c..ea90afd688d8622ee2128366c2b3e20d5302977a 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -40,14 +40,31 @@ export interface MessageValue<
 }
 
 /**
- * Worker function that can be executed types.
+ * Worker synchronous function that can be executed.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  */
 export type WorkerSyncFunction<Data = unknown, Response = unknown> = (
   data?: Data
 ) => Response
+/**
+ * Worker asynchronous function that can be executed.
+ * This function must return a promise.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
+ */
 export type WorkerAsyncFunction<Data = unknown, Response = unknown> = (
   data?: Data
 ) => Promise<Response>
+/**
+ * Worker function that can be executed.
+ * This function can be synchronous or asynchronous.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
+ */
 export type WorkerFunction<Data = unknown, Response = unknown> =
   | WorkerSyncFunction<Data, Response>
   | WorkerAsyncFunction<Data, Response>