Initial comment conversion to TSDoc

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 8fb8130a6bd2f268a8d41e51d7f9ce54c7d8fc1c..2d142f860e4b19893a131e7cbc872abda5f8270a 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,56 +1,68 @@
-import type { Worker } from 'cluster'
+import type { Worker as ClusterWorker } from 'cluster'
 import type { MessagePort } from 'worker_threads'
+import type { IPoolWorker } from './pools/pool-worker'
+import type { KillBehavior } from './worker/worker-options'
 
 /**
- * Make all properties in T non-readonly
+ * 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>
-
 /**
  * Message object that is passed between worker and main worker.
  */
 export interface MessageValue<
   Data = unknown,
-  MainWorker extends Worker | MessagePort | unknown = unknown
+  MainWorker extends ClusterWorker | MessagePort | unknown = unknown
 > {
   /**
    * Input data that will be passed to the worker.
    */
   readonly data?: Data
   /**
-   * ID of the message.
+   * Id of the message.
    */
   readonly id?: number
   /**
    * Kill code.
    */
-  readonly kill?: 'HARD' | 'SOFT' | number
+  readonly kill?: KillBehavior | 1
   /**
    * Error.
    */
   readonly error?: string
+  /**
+   * Task runtime.
+   */
+  readonly taskRunTime?: number
   /**
    * Reference to main worker.
    *
-   * _Only for internal use_
+   * Only for internal use.
    */
   readonly parent?: MainWorker
 }
+
+/**
+ * An object holding the worker that will be used to resolve/rejects the promise later on.
+ *
+ * @typeParam Worker - Type of worker.
+ * @typeParam Response - Type of response of execution. This can only be serializable data.
+ */
+export interface PromiseWorkerResponseWrapper<
+  Worker extends IPoolWorker,
+  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 that has the assigned task.
+   */
+  readonly worker: Worker
+}