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 serializable data.
38 export interface Task
<Data
= unknown
> {
40 * Input data that will be passed to the worker.
44 * UUID of the message.
50 * Worker tasks usage statistics.
54 export interface TasksUsage
{
56 * Number of tasks executed.
60 * Number of tasks running.
68 * Tasks runtime history.
70 runTimeHistory
: CircularArray
<number>
72 * Average tasks runtime.
76 * Median tasks runtime.
80 * Number of tasks errored.
88 export interface IWorker
{
90 * Register an event listener.
92 * @param event - The event.
93 * @param handler - The event listener.
95 on
: ((event
: 'message', handler
: MessageHandler
<this>) => void) &
96 ((event
: 'error', handler
: ErrorHandler
<this>) => void) &
97 ((event
: 'online', handler
: OnlineHandler
<this>) => void) &
98 ((event
: 'exit', handler
: ExitHandler
<this>) => void)
100 * Register a listener to the exit event that will only performed once.
102 * @param event - `'exit'`.
103 * @param handler - The exit handler.
105 once
: (event
: 'exit', handler
: ExitHandler
<this>) => void
109 * Worker node interface.
111 * @typeParam Worker - Type of worker.
112 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
115 export interface WorkerNode
<Worker
extends IWorker
, Data
= unknown
> {
117 * Worker node worker.
119 readonly worker
: Worker
121 * Worker node tasks usage statistics.
123 tasksUsage
: TasksUsage
125 * Worker node tasks queue.
127 readonly tasksQueue
: Array<Task
<Data
>>