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 { IPoolWorker } from './pools/pool-worker'
+import type { IWorker, Task } from './pools/worker'
/**
* 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] }
/**
- * Message object that is passed between worker and main worker.
+ * Performance statistics computation.
+ */
+export interface WorkerStatistics {
+ runTime: boolean
+ waitTime: boolean
+ elu: boolean
+}
+
+/**
+ * Message object that is passed between main worker and worker.
+ *
+ * @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<
Data = unknown,
- MainWorker extends ClusterWorker | MessagePort | unknown = unknown
-> {
+ MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
+> extends Task<Data> {
/**
- * Input data that will be passed to the worker.
+ * Kill code.
*/
- readonly data?: Data
+ readonly kill?: KillBehavior | 1
/**
- * Id of the message.
+ * Task error.
*/
- readonly id?: string
+ readonly error?: string
/**
- * Kill code.
+ * Task data triggering task error.
*/
- readonly kill?: KillBehavior | 1
+ readonly errorData?: unknown
/**
- * Error.
+ * Runtime.
*/
- readonly error?: string
+ readonly runTime?: number
/**
- * Task runtime.
+ * Wait time.
*/
- readonly taskRunTime?: number
+ readonly waitTime?: number
+ /**
+ * Event loop utilization.
+ */
+ readonly elu?: EventLoopUtilization
/**
* Reference to main worker.
- *
- * Only for internal use.
*/
readonly parent?: MainWorker
+ /**
+ * Whether to compute the given statistics or not.
+ */
+ readonly statistics?: WorkerStatistics
}
/**
*
* @typeParam Worker - Type of worker.
* @typeParam Response - Type of execution response. This can only be serializable data.
+ * @internal
*/
export interface PromiseResponseWrapper<
- Worker extends IPoolWorker,
+ Worker extends IWorker,
Response = unknown
> {
/**
*/
readonly reject: (reason?: string) => void
/**
- * The worker handling the promise.
+ * The worker handling the execution.
*/
readonly worker: Worker
}