docs: refine code comment
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Thu, 4 Apr 2024 09:33:10 +0000 (11:33 +0200)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Thu, 4 Apr 2024 09:33:10 +0000 (11:33 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
src/worker/task-functions.ts

index b912f05c2f5c5d6f1032a4db3e4d353998acaca5..5518043eb022857209401a32ecd0a0a9d18bcf30 100644 (file)
@@ -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.