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
60 * Worker tasks usage statistics.
64 export interface TasksUsage
{
66 * Number of tasks executed.
70 * Number of tasks running.
78 * Tasks runtime history.
80 runTimeHistory
: CircularArray
<number>
82 * Average tasks runtime.
86 * Median tasks runtime.
94 * Tasks wait time history.
96 waitTimeHistory
: CircularArray
<number>
98 * Average tasks wait time.
102 * Median tasks wait time.
106 * Number of tasks errored.
110 * Event loop utilization.
112 elu
: EventLoopUtilization
| undefined
118 export interface IWorker
{
120 * Register an event listener.
122 * @param event - The event.
123 * @param handler - The event handler.
125 on
: ((event
: 'message', handler
: MessageHandler
<this>) => void) &
126 ((event
: 'error', handler
: ErrorHandler
<this>) => void) &
127 ((event
: 'online', handler
: OnlineHandler
<this>) => void) &
128 ((event
: 'exit', handler
: ExitHandler
<this>) => void)
130 * Register a listener to the exit event that will only be performed once.
132 * @param event - `'exit'`.
133 * @param handler - The exit handler.
135 once
: (event
: 'exit', handler
: ExitHandler
<this>) => void
139 * Worker node interface.
141 * @typeParam Worker - Type of worker.
142 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
145 export interface WorkerNode
<Worker
extends IWorker
, Data
= unknown
> {
147 * Worker node worker.
149 readonly worker
: Worker
151 * Worker node tasks usage statistics.
153 tasksUsage
: TasksUsage
155 * Worker node tasks queue.
157 readonly tasksQueue
: Queue
<Task
<Data
>>