From: Jérôme Benoit <jerome.benoit@piment-noir.org>
Date: Thu, 4 Apr 2024 09:33:10 +0000 (+0200)
Subject: docs: refine code comment
X-Git-Tag: v3.1.30~38
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=77e8da5a0633e5a282ddc82f52b354101d112f0f;p=poolifier.git

docs: refine code comment

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
---

diff --git a/src/worker/task-functions.ts b/src/worker/task-functions.ts
index b912f05c..5518043e 100644
--- a/src/worker/task-functions.ts
+++ b/src/worker/task-functions.ts
@@ -2,6 +2,7 @@
  * Task synchronous function that can be executed.
  *
  * @param data - Data sent to the worker.
+ * @returns Execution response.
  *
  * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
@@ -15,6 +16,7 @@ export type TaskSyncFunction<Data = unknown, Response = unknown> = (
  * This function must return a promise.
  *
  * @param data - Data sent to the worker.
+ * @returns Execution response promise.
  *
  * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @typeParam Response - Type of execution response. This can only be structured-cloneable data.