-import type { Worker } from 'cluster'
-import type { MessagePort } from 'worker_threads'
+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
+ * 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
+ readonly id?: string
/**
* Kill code.
*/
- readonly kill?: 'HARD' | 'SOFT' | number
+ readonly kill?: KillBehavior | 1
/**
* Error.
*/
readonly error?: string
+ /**
+ * Runtime.
+ */
+ readonly runTime?: number
/**
* Reference to main worker.
*
- * _Only for internal use_
+ * Only for internal use.
*/
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.
+ */
+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
+}