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 minimum.
73 * Measurement maximum.
77 * Measurement average.
85 * Measurement history.
87 readonly history
: CircularArray
<number>
91 * Event loop utilization measurement statistics.
95 export interface EventLoopUtilizationMeasurementStatistics
{
96 readonly idle
: MeasurementStatistics
97 readonly active
: MeasurementStatistics
106 export interface TaskStatistics
{
108 * Number of executed tasks.
112 * Number of executing tasks.
116 * Number of queued tasks.
118 readonly queued
: number
120 * Maximum number of queued tasks.
122 readonly maxQueued
: number
124 * Number of failed tasks.
130 * Worker information.
134 export interface WorkerInfo
{
138 readonly id
: number | undefined
150 * Worker usage statistics.
154 export interface WorkerUsage
{
158 readonly tasks
: TaskStatistics
160 * Tasks runtime statistics.
162 readonly runTime
: MeasurementStatistics
164 * Tasks wait time statistics.
166 readonly waitTime
: MeasurementStatistics
168 * Tasks event loop utilization statistics.
170 readonly elu
: EventLoopUtilizationMeasurementStatistics
176 export interface IWorker
{
181 readonly threadId
?: number
183 * Registers an event listener.
185 * @param event - The event.
186 * @param handler - The event handler.
188 on
: ((event
: 'message', handler
: MessageHandler
<this>) => void) &
189 ((event
: 'error', handler
: ErrorHandler
<this>) => void) &
190 ((event
: 'online', handler
: OnlineHandler
<this>) => void) &
191 ((event
: 'exit', handler
: ExitHandler
<this>) => void)
193 * Registers a listener to the exit event that will only be performed once.
195 * @param event - `'exit'`.
196 * @param handler - The exit handler.
198 once
: (event
: 'exit', handler
: ExitHandler
<this>) => void
202 * Worker node interface.
204 * @typeParam Worker - Type of worker.
205 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
208 export interface WorkerNode
<Worker
extends IWorker
, Data
= unknown
> {
210 * Worker node worker.
212 readonly worker
: Worker
214 * Worker node worker info.
216 readonly info
: WorkerInfo
218 * Worker node worker usage statistics.
222 * Worker node tasks queue.
224 readonly tasksQueue
: Queue
<Task
<Data
>>