-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 { EventLoopUtilization } from 'node:perf_hooks'
+import type { KillBehavior } from './worker/worker-options'
+import type { IWorker, Task } from './pools/worker'
-export type KillBehavior = 'HARD' | 'SOFT'
/**
- * Make all properties in T non-readonly
+ * Make all properties in T non-readonly.
+ *
+ * @typeParam T - Type in which properties will be non-readonly.
*/
export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
/**
- * Serializable primitive JSON value.
+ * Task error.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
*/
-export type JSONPrimitive = number | boolean | string | null
-/**
- * Serializable JSON value.
- */
-// eslint-disable-next-line no-use-before-define
-export type JSONValue = JSONPrimitive | JSONArray | JSONObject
+export interface TaskError<Data = unknown> {
+ /**
+ * Error message.
+ */
+ message: string
+ /**
+ * Data passed to the worker triggering the error.
+ */
+ data?: Data
+}
+
/**
- * Serializable JSON object.
+ * Task performance.
*/
-export type JSONObject = { [k: string]: JSONValue }
+export interface TaskPerformance {
+ /**
+ * Task performance timestamp.
+ */
+ timestamp: number
+ /**
+ * Task runtime.
+ */
+ runTime?: number
+ /**
+ * Task event loop utilization.
+ */
+ elu?: EventLoopUtilization
+}
+
/**
- * Serializable JSON array.
+ * Performance statistics computation.
*/
-export type JSONArray = Array<JSONValue>
+export interface WorkerStatistics {
+ runTime: boolean
+ elu: boolean
+}
/**
- * Message object that is passed between worker and main worker.
+ * Message object that is passed between main worker and worker.
+ *
+ * @typeParam MessageData - Type of data sent to and/or from the worker. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam MainWorker - Type of main worker.
+ * @internal
*/
export interface MessageValue<
+ MessageData = unknown,
Data = unknown,
- MainWorker extends Worker | MessagePort | unknown = unknown
-> {
- /**
- * Input data that will be passed to the worker.
- */
- readonly data?: Data
+ MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
+> extends Task<MessageData> {
/**
- * ID of the message.
+ * Kill code.
*/
- readonly id?: number
+ readonly kill?: KillBehavior | 1
/**
- * Kill code.
+ * Task error.
*/
- readonly kill?: KillBehavior | number
+ readonly taskError?: TaskError<Data>
/**
- * Error.
+ * Task performance.
*/
- readonly error?: string
+ readonly taskPerformance?: TaskPerformance
/**
* Reference to main worker.
- *
- * _Only for internal use_
*/
readonly parent?: MainWorker
+ /**
+ * Whether to compute the given statistics or not.
+ */
+ readonly statistics?: WorkerStatistics
}
+/**
+ * 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.
+ * @internal
+ */
+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
+}