-import type { EventLoopUtilization } from 'node:perf_hooks'
import type { CircularArray } from '../circular-array'
import type { Queue } from '../queue'
*/
export type MessageHandler<Worker extends IWorker> = (
this: Worker,
- m: unknown
+ message: unknown
) => void
/**
*/
export type ErrorHandler<Worker extends IWorker> = (
this: Worker,
- e: Error
+ error: Error
) => void
/**
*/
export type ExitHandler<Worker extends IWorker> = (
this: Worker,
- code: number
+ exitCode: number
) => void
/**
* Message object that is passed as a task between main worker and worker.
*
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
* @internal
*/
export interface Task<Data = unknown> {
*/
export interface MeasurementStatistics {
/**
- * Measurement aggregation.
+ * Measurement aggregate.
*/
- aggregation: number
+ aggregate: number
/**
* Measurement average.
*/
/**
* Measurement history.
*/
- history: CircularArray<number>
+ readonly history: CircularArray<number>
+}
+
+/**
+ * Event loop utilization measurement statistics.
+ *
+ * @internal
+ */
+export interface EventLoopUtilizationMeasurementStatistics {
+ readonly idle: MeasurementStatistics
+ readonly active: MeasurementStatistics
+ utilization: number
}
/**
*/
export interface TaskStatistics {
/**
- * Number of tasks executed.
+ * Number of executed tasks.
*/
executed: number
/**
- * Number of tasks executing.
+ * Number of executing tasks.
*/
executing: number
/**
- * Number of tasks queued.
+ * Number of queued tasks.
*/
- queued: number
+ readonly queued: number
/**
- * Number of tasks failed.
+ * Maximum number of queued tasks.
+ */
+ readonly maxQueued: number
+ /**
+ * Number of failed tasks.
*/
failed: number
}
+/**
+ * Worker information.
+ *
+ * @internal
+ */
+export interface WorkerInfo {
+ /**
+ * Worker id.
+ */
+ readonly id: number | undefined
+ /**
+ * Started flag.
+ */
+ started: boolean
+ /**
+ * Shared buffer.
+ */
+ readonly sharedBuffer?: Int32Array
+}
+
/**
* Worker usage statistics.
*
/**
* Tasks statistics.
*/
- tasks: TaskStatistics
+ readonly tasks: TaskStatistics
/**
* Tasks runtime statistics.
*/
- runTime: MeasurementStatistics
+ readonly runTime: MeasurementStatistics
/**
* Tasks wait time statistics.
*/
- waitTime: MeasurementStatistics
+ readonly waitTime: MeasurementStatistics
/**
- * Event loop utilization.
+ * Tasks event loop utilization statistics.
*/
- elu: EventLoopUtilization | undefined
+ readonly elu: EventLoopUtilizationMeasurementStatistics
}
/**
*/
export interface IWorker {
/**
- * Register an event listener.
+ * Worker id.
+ */
+ readonly id?: number
+ readonly threadId?: number
+ /**
+ * Registers an event listener.
*
* @param event - The event.
* @param handler - The event handler.
((event: 'online', handler: OnlineHandler<this>) => void) &
((event: 'exit', handler: ExitHandler<this>) => void)
/**
- * Register a listener to the exit event that will only be performed once.
+ * Registers a listener to the exit event that will only be performed once.
*
* @param event - `'exit'`.
* @param handler - The exit handler.
* Worker node interface.
*
* @typeParam Worker - Type of worker.
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
* @internal
*/
export interface WorkerNode<Worker extends IWorker, Data = unknown> {
* Worker node worker.
*/
readonly worker: Worker
+ /**
+ * Worker node worker info.
+ */
+ readonly info: WorkerInfo
/**
* Worker node worker usage statistics.
*/
- workerUsage: WorkerUsage
+ usage: WorkerUsage
/**
* Worker node tasks queue.
*/