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 readonly history
: CircularArray
<number>
83 * Event loop utilization measurement statistics.
87 export interface EventLoopUtilizationMeasurementStatistics
{
88 readonly idle
: MeasurementStatistics
89 readonly 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 readonly id
: number | undefined
138 readonly sharedBuffer
?: Int32Array
142 * Worker usage statistics.
146 export interface WorkerUsage
{
150 readonly tasks
: TaskStatistics
152 * Tasks runtime statistics.
154 readonly runTime
: MeasurementStatistics
156 * Tasks wait time statistics.
158 readonly waitTime
: MeasurementStatistics
160 * Tasks event loop utilization statistics.
162 readonly elu
: EventLoopUtilizationMeasurementStatistics
168 export interface IWorker
{
173 readonly threadId
?: number
175 * Registers an event listener.
177 * @param event - The event.
178 * @param handler - The event handler.
180 on
: ((event
: 'message', handler
: MessageHandler
<this>) => void) &
181 ((event
: 'error', handler
: ErrorHandler
<this>) => void) &
182 ((event
: 'online', handler
: OnlineHandler
<this>) => void) &
183 ((event
: 'exit', handler
: ExitHandler
<this>) => void)
185 * Registers a listener to the exit event that will only be performed once.
187 * @param event - `'exit'`.
188 * @param handler - The exit handler.
190 once
: (event
: 'exit', handler
: ExitHandler
<this>) => void
194 * Worker node interface.
196 * @typeParam Worker - Type of worker.
197 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
200 export interface WorkerNode
<Worker
extends IWorker
, Data
= unknown
> {
202 * Worker node worker.
204 readonly worker
: Worker
206 * Worker node worker info.
208 readonly info
: WorkerInfo
210 * Worker node worker usage statistics.
214 * Worker node tasks queue.
216 readonly tasksQueue
: Queue
<Task
<Data
>>