1 import type { CircularArray
} from
'../circular-array'
2 import type { Queue
} from
'../queue'
5 * Callback invoked if the worker has received a message.
7 export type MessageHandler
<Worker
extends IWorker
> = (
13 * Callback invoked if the worker raised an error.
15 export type ErrorHandler
<Worker
extends IWorker
> = (
21 * Callback invoked when the worker has started successfully.
23 export type OnlineHandler
<Worker
extends IWorker
> = (this: Worker
) => void
26 * Callback invoked when the worker exits successfully.
28 export type ExitHandler
<Worker
extends IWorker
> = (
34 * Message object that is passed as a task between main worker and worker.
36 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
39 export interface Task
<Data
= unknown
> {
43 readonly name
?: string
45 * Task input data that will be passed to the worker.
51 readonly timestamp
?: number
59 * Measurement statistics.
63 export interface MeasurementStatistics
{
65 * Measurement aggregate.
69 * Measurement average.
77 * Measurement history.
79 history
: CircularArray
<number>
83 * Event loop utilization measurement statistics.
87 export interface EventLoopUtilizationMeasurementStatistics
{
88 idle
: MeasurementStatistics
89 active
: MeasurementStatistics
98 export interface TaskStatistics
{
100 * Number of executed tasks.
104 * Number of executing tasks.
108 * Number of queued tasks.
110 readonly queued
: number
112 * Maximum number of queued tasks.
114 readonly maxQueued
: number
116 * Number of failed tasks.
122 * Worker information.
126 export interface WorkerInfo
{
130 id
: number | undefined
138 * Worker usage statistics.
142 export interface WorkerUsage
{
146 tasks
: TaskStatistics
148 * Tasks runtime statistics.
150 runTime
: MeasurementStatistics
152 * Tasks wait time statistics.
154 waitTime
: MeasurementStatistics
156 * Tasks event loop utilization statistics.
158 elu
: EventLoopUtilizationMeasurementStatistics
164 export interface IWorker
{
169 readonly threadId
?: number
171 * Register an event listener.
173 * @param event - The event.
174 * @param handler - The event handler.
176 on
: ((event
: 'message', handler
: MessageHandler
<this>) => void) &
177 ((event
: 'error', handler
: ErrorHandler
<this>) => void) &
178 ((event
: 'online', handler
: OnlineHandler
<this>) => void) &
179 ((event
: 'exit', handler
: ExitHandler
<this>) => void)
181 * Register a listener to the exit event that will only be performed once.
183 * @param event - `'exit'`.
184 * @param handler - The exit handler.
186 once
: (event
: 'exit', handler
: ExitHandler
<this>) => void
190 * Worker node interface.
192 * @typeParam Worker - Type of worker.
193 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
196 export interface WorkerNode
<Worker
extends IWorker
, Data
= unknown
> {
198 * Worker node worker.
200 readonly worker
: Worker
202 * Worker node worker info.
206 * Worker node worker usage statistics.
210 * Worker node tasks queue.
212 readonly tasksQueue
: Queue
<Task
<Data
>>