docs: enhance documentation

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 5a3ef4c565f184e5712d2f47f755848a62f3cb42..685e5c4c606755bf801dd6c13d582d3657f8fe8e 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,9 +1,73 @@
+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 } from './pools/worker'
+
+/**
+ * Make all properties in T non-readonly.
+ */
 export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
 
-export interface MessageValue<Data> {
+/**
+ * Message object that is passed between worker and main worker.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam MainWorker - Type of main worker.
+ */
+export interface MessageValue<
+  Data = unknown,
+  MainWorker extends ClusterWorker | MessagePort | unknown = unknown
+> {
+  /**
+   * Input data that will be passed to the worker.
+   */
   readonly data?: Data
-  readonly id?: number
-  readonly kill?: number
+  /**
+   * Id of the message.
+   */
+  readonly id?: string
+  /**
+   * Kill code.
+   */
+  readonly kill?: KillBehavior | 1
+  /**
+   * Error.
+   */
   readonly error?: string
-  readonly parent?: MessagePort
+  /**
+   * Runtime.
+   */
+  readonly runTime?: number
+  /**
+   * Reference to main worker.
+   *
+   * Only for internal use.
+   * @internal
+   */
+  readonly parent?: MainWorker
+}
+
+/**
+ * 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 PromiseResponseWrapper<
+  Worker extends IWorker,
+  Response = unknown
+> {
+  /**
+   * Resolve callback to fulfill the promise.
+   */
+  readonly resolve: (value: Response) => void
+  /**
+   * Reject callback to reject the promise.
+   */
+  readonly reject: (reason?: string) => void
+  /**
+   * The worker handling the execution.
+   */
+  readonly worker: Worker
 }