import type { CircularArray } from '../circular-array'
+import type { Queue } from '../queue'
/**
* Callback invoked if the worker has received a message.
*/
export interface Task<Data = unknown> {
/**
- * Input data that will be passed to the worker.
+ * Task name.
+ */
+ readonly name?: string
+ /**
+ * Task input data that will be passed to the worker.
*/
readonly data?: Data
/**
- * UUID of the message.
+ * Timestamp.
+ */
+ readonly timestamp?: number
+ /**
+ * Message UUID.
*/
readonly id?: string
}
/**
- * Worker tasks usage statistics.
+ * Measurement statistics.
+ *
+ * @internal
+ */
+export interface MeasurementStatistics {
+ /**
+ * Measurement aggregate.
+ */
+ aggregate: number
+ /**
+ * Measurement average.
+ */
+ average: number
+ /**
+ * Measurement median.
+ */
+ median: number
+ /**
+ * Measurement history.
+ */
+ history: CircularArray<number>
+}
+
+/**
+ * Event loop utilization measurement statistics.
+ *
+ * @internal
+ */
+export interface EventLoopUtilizationMeasurementStatistics {
+ idle: MeasurementStatistics
+ active: MeasurementStatistics
+ utilization: number
+}
+
+/**
+ * Task statistics.
+ *
+ * @internal
*/
-export interface TasksUsage {
+export interface TaskStatistics {
/**
- * Number of tasks executed.
+ * Number of executed tasks.
*/
- run: number
+ executed: number
/**
- * Number of tasks running.
+ * Number of executing tasks.
*/
- running: number
+ executing: number
/**
- * Tasks runtime.
+ * Number of queued tasks.
*/
- runTime: number
+ readonly queued: number
+ /**
+ * Number of failed tasks.
+ */
+ failed: number
+}
+
+/**
+ * Worker usage statistics.
+ *
+ * @internal
+ */
+export interface WorkerUsage {
/**
- * Tasks runtime history.
+ * Tasks statistics.
*/
- runTimeHistory: CircularArray<number>
+ tasks: TaskStatistics
/**
- * Average tasks runtime.
+ * Tasks runtime statistics.
*/
- avgRunTime: number
+ runTime: MeasurementStatistics
/**
- * Median tasks runtime.
+ * Tasks wait time statistics.
*/
- medRunTime: number
+ waitTime: MeasurementStatistics
/**
- * Number of tasks errored.
+ * Tasks event loop utilization statistics.
*/
- error: number
+ elu: EventLoopUtilizationMeasurementStatistics
}
/**
* Register an event listener.
*
* @param event - The event.
- * @param handler - The event listener.
+ * @param handler - The event handler.
*/
on: ((event: 'message', handler: MessageHandler<this>) => void) &
((event: 'error', handler: ErrorHandler<this>) => void) &
((event: 'online', handler: OnlineHandler<this>) => void) &
((event: 'exit', handler: ExitHandler<this>) => void)
/**
- * Register a listener to the exit event that will only performed once.
+ * Register a listener to the exit event that will only be performed once.
*
* @param event - `'exit'`.
* @param handler - The exit handler.
*/
readonly worker: Worker
/**
- * Worker node tasks usage statistics.
+ * Worker node worker usage statistics.
*/
- tasksUsage: TasksUsage
+ workerUsage: WorkerUsage
/**
* Worker node tasks queue.
*/
- readonly tasksQueue: Array<Task<Data>>
+ readonly tasksQueue: Queue<Task<Data>>
}