1 import type { EventLoopUtilization
} from
'node:perf_hooks'
2 import type { CircularArray
} from
'../circular-array'
3 import type { Queue
} from
'../queue'
6 * Callback invoked if the worker has received a message.
8 export type MessageHandler
<Worker
extends IWorker
> = (
14 * Callback invoked if the worker raised an error.
16 export type ErrorHandler
<Worker
extends IWorker
> = (
22 * Callback invoked when the worker has started successfully.
24 export type OnlineHandler
<Worker
extends IWorker
> = (this: Worker
) => void
27 * Callback invoked when the worker exits successfully.
29 export type ExitHandler
<Worker
extends IWorker
> = (
35 * Message object that is passed as a task between main worker and worker.
37 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
40 export interface Task
<Data
= unknown
> {
44 readonly name
?: string
46 * Task input data that will be passed to the worker.
52 readonly timestamp
?: number
60 * Measurement statistics.
64 export interface MeasurementStatistics
{
66 * Measurement aggregation.
70 * Measurement average.
78 * Measurement history.
80 history
: CircularArray
<number>
88 export interface TaskStatistics
{
90 * Number of executed tasks.
94 * Number of executing tasks.
98 * Number of queued tasks.
100 readonly queued
: number
102 * Number of failed tasks.
108 * Worker usage statistics.
112 export interface WorkerUsage
{
116 tasks
: TaskStatistics
118 * Tasks runtime statistics.
120 runTime
: MeasurementStatistics
122 * Tasks wait time statistics.
124 waitTime
: MeasurementStatistics
126 * Event loop utilization.
128 elu
: EventLoopUtilization
| undefined
134 export interface IWorker
{
136 * Register an event listener.
138 * @param event - The event.
139 * @param handler - The event handler.
141 on
: ((event
: 'message', handler
: MessageHandler
<this>) => void) &
142 ((event
: 'error', handler
: ErrorHandler
<this>) => void) &
143 ((event
: 'online', handler
: OnlineHandler
<this>) => void) &
144 ((event
: 'exit', handler
: ExitHandler
<this>) => void)
146 * Register a listener to the exit event that will only be performed once.
148 * @param event - `'exit'`.
149 * @param handler - The exit handler.
151 once
: (event
: 'exit', handler
: ExitHandler
<this>) => void
155 * Worker node interface.
157 * @typeParam Worker - Type of worker.
158 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
161 export interface WorkerNode
<Worker
extends IWorker
, Data
= unknown
> {
163 * Worker node worker.
165 readonly worker
: Worker
167 * Worker node worker usage statistics.
169 workerUsage
: WorkerUsage
171 * Worker node tasks queue.
173 readonly tasksQueue
: Queue
<Task
<Data
>>