build: bump volta node version
[poolifier.git] / src / worker / task-functions.ts
index a61d69627ce6eeebd36e462f5801c36e94cc8e06..b912f05c2f5c5d6f1032a4db3e4d353998acaca5 100644 (file)
@@ -1,6 +1,8 @@
 /**
  * Task synchronous function that can be executed.
  *
+ * @param data - Data sent to the worker.
+ *
  * @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.
  */
@@ -12,6 +14,8 @@ export type TaskSyncFunction<Data = unknown, Response = unknown> = (
  * Task asynchronous function that can be executed.
  * This function must return a promise.
  *
+ * @param data - Data sent to the worker.
+ *
  * @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.
  */
@@ -43,3 +47,11 @@ export type TaskFunctions<Data = unknown, Response = unknown> = Record<
 string,
 TaskFunction<Data, Response>
 >
+
+/**
+ * Task function operation result.
+ */
+export interface TaskFunctionOperationResult {
+  status: boolean
+  error?: Error
+}