1 import type { CircularArray
} from
'../circular-array'
4 * Callback invoked if the worker has received a message.
6 export type MessageHandler
<Worker
extends IWorker
> = (
12 * Callback invoked if the worker raised an error.
14 export type ErrorHandler
<Worker
extends IWorker
> = (
20 * Callback invoked when the worker has started successfully.
22 export type OnlineHandler
<Worker
extends IWorker
> = (this: Worker
) => void
25 * Callback invoked when the worker exits successfully.
27 export type ExitHandler
<Worker
extends IWorker
> = (
33 * Message object that is passed as a task between main worker and worker.
35 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
38 export interface Task
<Data
= unknown
> {
42 readonly workerId
: number
46 readonly name
?: string
48 * Task input data that will be passed to the worker.
54 readonly timestamp
?: number
62 * Measurement statistics.
66 export interface MeasurementStatistics
{
68 * Measurement aggregate.
72 * Measurement minimum.
76 * Measurement maximum.
80 * Measurement average.
88 * Measurement history.
90 readonly history
: CircularArray
<number>
94 * Event loop utilization measurement statistics.
98 export interface EventLoopUtilizationMeasurementStatistics
{
99 readonly idle
: MeasurementStatistics
100 readonly active
: MeasurementStatistics
109 export interface TaskStatistics
{
111 * Number of executed tasks.
115 * Number of executing tasks.
119 * Number of queued tasks.
121 readonly queued
: number
123 * Maximum number of queued tasks.
125 readonly maxQueued
: number
127 * Number of failed tasks.
133 * Enumeration of worker types.
135 export const WorkerTypes
= Object.freeze({
143 export type WorkerType
= keyof
typeof WorkerTypes
146 * Worker information.
150 export interface WorkerInfo
{
154 readonly id
: number | undefined
170 * Worker usage statistics.
174 export interface WorkerUsage
{
178 readonly tasks
: TaskStatistics
180 * Tasks runtime statistics.
182 readonly runTime
: MeasurementStatistics
184 * Tasks wait time statistics.
186 readonly waitTime
: MeasurementStatistics
188 * Tasks event loop utilization statistics.
190 readonly elu
: EventLoopUtilizationMeasurementStatistics
196 export interface IWorker
{
201 readonly threadId
?: number
203 * Registers an event listener.
205 * @param event - The event.
206 * @param handler - The event handler.
208 readonly on
: ((event
: 'message', handler
: MessageHandler
<this>) => void) &
209 ((event
: 'error', handler
: ErrorHandler
<this>) => void) &
210 ((event
: 'online', handler
: OnlineHandler
<this>) => void) &
211 ((event
: 'exit', handler
: ExitHandler
<this>) => void)
213 * Registers a listener to the exit event that will only be performed once.
215 * @param event - `'exit'`.
216 * @param handler - The exit handler.
218 readonly once
: (event
: 'exit', handler
: ExitHandler
<this>) => void
222 * Worker node interface.
224 * @typeParam Worker - Type of worker.
225 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
228 export interface IWorkerNode
<Worker
extends IWorker
, Data
= unknown
> {
230 * Worker node worker.
232 readonly worker
: Worker
234 * Worker node worker info.
236 readonly info
: WorkerInfo
238 * Worker node worker usage statistics.
242 * Worker node tasks queue size.
244 * @returns The tasks queue size.
246 readonly tasksQueueSize
: () => number
248 * Worker node enqueue task.
250 * @param task - The task to queue.
251 * @returns The task queue size.
253 readonly enqueueTask
: (task
: Task
<Data
>) => number
255 * Worker node dequeue task.
257 * @returns The dequeued task.
259 readonly dequeueTask
: () => Task
<Data
> | undefined
261 * Worker node clear tasks queue.
263 readonly clearTasksQueue
: () => void
265 * Worker node reset usage statistics .
267 readonly resetUsage
: () => void