X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=2403b8a257b0377e441a4dc2568b49571be4cdc2;hb=deb85c12b77faf6974551cefcd9676e62a392086;hp=5a3ef4c565f184e5712d2f47f755848a62f3cb42;hpb=325f50bc1777ea44abc9736ce9d780ec0c8f90e2;p=poolifier.git

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 5a3ef4c5..2403b8a2 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,9 +1,39 @@
+import type { Worker } from 'cluster'
+import type { MessagePort } from 'worker_threads'
+import type { KillBehavior } from './worker/worker-options'
+
+/**
+ * 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.
+ */
+export interface MessageValue<
+  Data = unknown,
+  MainWorker extends Worker | MessagePort | unknown = unknown
+> {
+  /**
+   * Input data that will be passed to the worker.
+   */
   readonly data?: Data
+  /**
+   * ID of the message.
+   */
   readonly id?: number
-  readonly kill?: number
+  /**
+   * Kill code.
+   */
+  readonly kill?: KillBehavior | 1
+  /**
+   * Error.
+   */
   readonly error?: string
-  readonly parent?: MessagePort
+  /**
+   * Reference to main worker.
+   *
+   * _Only for internal use_
+   */
+  readonly parent?: MainWorker
 }