Improvements for #161 (#169)

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 5a3ef4c565f184e5712d2f47f755848a62f3cb42..d680fa16ddc7e4748a41f2e878def0384eb2e305 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,9 +1,57 @@
+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> {
+/**
+ * Serializable primitive JSON value.
+ */
+export type JSONPrimitive = number | boolean | string | null
+/**
+ * Serializable JSON value.
+ */
+// eslint-disable-next-line no-use-before-define
+export type JSONValue = JSONPrimitive | JSONArray | JSONObject
+/**
+ * Serializable JSON object.
+ */
+export type JSONObject = { [k: string]: JSONValue }
+/**
+ * Serializable JSON array.
+ */
+export type JSONArray = Array<JSONValue>
+
+/**
+ * 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
 }