Merge pull request #164 from pioardi/benchmark

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index e177adaeb7ccaf8022c338013284201e23ed1ed7..eb3f9727369f837d9cd36d5bd6b7dd69c9d5f0c3 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,15 +1,56 @@
+import type { Worker } from 'cluster'
+import type { MessagePort } from 'worker_threads'
+
+/**
+ * Make all properties in T non-readonly
+ */
 export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
 
+/**
+ * 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>
 
-export interface MessageValue<Data = unknown> {
+/**
+ * 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
+  /**
+   * Kill code.
+   */
   readonly kill?: number
+  /**
+   * Error.
+   */
   readonly error?: string
-  readonly parent?: MessagePort
+  /**
+   * Reference to main worker.
+   *
+   * _Only for internal use_
+   */
+  readonly parent?: MainWorker
 }