4d935a113336921a5f49e6858046b07a863096fd
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
64 export interface MeasureStatistics
{
66 * Measure aggregation.
80 history
: CircularArray
<number>
89 export interface TaskStatistics
{
91 * Number of tasks executed.
95 * Number of tasks executing.
99 * Number of tasks queued.
103 * Number of tasks failed.
109 * Worker usage statistics.
113 export interface WorkerUsage
{
117 tasks
: TaskStatistics
119 * Tasks runtime statistics.
121 runTime
: MeasureStatistics
123 * Tasks wait time statistics.
125 waitTime
: MeasureStatistics
127 * Event loop utilization.
129 elu
: EventLoopUtilization
| undefined
135 export interface IWorker
{
137 * Register an event listener.
139 * @param event - The event.
140 * @param handler - The event handler.
142 on
: ((event
: 'message', handler
: MessageHandler
<this>) => void) &
143 ((event
: 'error', handler
: ErrorHandler
<this>) => void) &
144 ((event
: 'online', handler
: OnlineHandler
<this>) => void) &
145 ((event
: 'exit', handler
: ExitHandler
<this>) => void)
147 * Register a listener to the exit event that will only be performed once.
149 * @param event - `'exit'`.
150 * @param handler - The exit handler.
152 once
: (event
: 'exit', handler
: ExitHandler
<this>) => void
156 * Worker node interface.
158 * @typeParam Worker - Type of worker.
159 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
162 export interface WorkerNode
<Worker
extends IWorker
, Data
= unknown
> {
164 * Worker node worker.
166 readonly worker
: Worker
168 * Worker node worker usage statistics.
170 workerUsage
: WorkerUsage
172 * Worker node tasks queue.
174 readonly tasksQueue
: Queue
<Task
<Data
>>