docs: add documentation to worker function type aliases

[poolifier.git] / src / utility-types.ts

diff --git a/src/utility-types.ts b/src/utility-types.ts
index eb3f9727369f837d9cd36d5bd6b7dd69c9d5f0c3..ea90afd688d8622ee2128366c2b3e20d5302977a 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,56 +1,95 @@
-import type { Worker } from 'cluster'
-import type { MessagePort } from 'worker_threads'
+import type { Worker as ClusterWorker } from 'node:cluster'
+import type { MessagePort } from 'node:worker_threads'
+import type { KillBehavior } from './worker/worker-options'
+import type { IWorker, Task } from './pools/worker'
 
 /**
- * Make all properties in T non-readonly
+ * Make all properties in T non-readonly.
+ *
+ * @typeParam T - Type in which properties will be non-readonly.
  */
 export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
 
 /**
- * Serializable primitive JSON value.
+ * Message object that is passed between main worker and worker.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam MainWorker - Type of main worker.
+ * @internal
  */
-export type JSONPrimitive = number | boolean | string | null
+export interface MessageValue<
+  Data = unknown,
+  MainWorker extends ClusterWorker | MessagePort | unknown = unknown
+> extends Task<Data> {
+  /**
+   * Kill code.
+   */
+  readonly kill?: KillBehavior | 1
+  /**
+   * Error.
+   */
+  readonly error?: string
+  /**
+   * Runtime.
+   */
+  readonly runTime?: number
+  /**
+   * Reference to main worker.
+   */
+  readonly parent?: MainWorker
+}
+
 /**
- * Serializable JSON value.
+ * 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.
  */
-// eslint-disable-next-line no-use-before-define
-export type JSONValue = JSONPrimitive | JSONArray | JSONObject
+export type WorkerSyncFunction<Data = unknown, Response = unknown> = (
+  data?: Data
+) => Response
 /**
- * Serializable JSON object.
+ * 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 JSONObject = { [k: string]: JSONValue }
+export type WorkerAsyncFunction<Data = unknown, Response = unknown> = (
+  data?: Data
+) => Promise<Response>
 /**
- * Serializable JSON array.
+ * 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 JSONArray = Array<JSONValue>
+export type WorkerFunction<Data = unknown, Response = unknown> =
+  | WorkerSyncFunction<Data, Response>
+  | WorkerAsyncFunction<Data, Response>
 
 /**
- * Message object that is passed between worker and main worker.
+ * An object holding the execution response promise resolve/reject callbacks.
+ *
+ * @typeParam Worker - Type of worker.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @internal
  */
-export interface MessageValue<
-  Data = unknown,
-  MainWorker extends Worker | MessagePort | unknown = unknown
+export interface PromiseResponseWrapper<
+  Worker extends IWorker,
+  Response = unknown
 > {
   /**
-   * Input data that will be passed to the worker.
-   */
-  readonly data?: Data
-  /**
-   * ID of the message.
+   * Resolve callback to fulfill the promise.
    */
-  readonly id?: number
+  readonly resolve: (value: Response) => void
   /**
-   * Kill code.
+   * Reject callback to reject the promise.
    */
-  readonly kill?: number
+  readonly reject: (reason?: string) => void
   /**
-   * Error.
+   * The worker handling the execution.
    */
-  readonly error?: string
-  /**
-   * Reference to main worker.
-   *
-   * _Only for internal use_
-   */
-  readonly parent?: MainWorker
+  readonly worker: Worker
 }