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.
52 export interface TasksUsage
{
54 * Number of tasks executed.
58 * Number of tasks running.
66 * Tasks runtime history.
68 runTimeHistory
: CircularArray
<number>
70 * Average tasks runtime.
74 * Median tasks runtime.
78 * Number of tasks errored.
86 export interface IWorker
{
88 * Register an event listener.
90 * @param event - The event.
91 * @param handler - The event listener.
93 on
: ((event
: 'message', handler
: MessageHandler
<this>) => void) &
94 ((event
: 'error', handler
: ErrorHandler
<this>) => void) &
95 ((event
: 'online', handler
: OnlineHandler
<this>) => void) &
96 ((event
: 'exit', handler
: ExitHandler
<this>) => void)
98 * Register a listener to the exit event that will only performed once.
100 * @param event - `'exit'`.
101 * @param handler - The exit handler.
103 once
: (event
: 'exit', handler
: ExitHandler
<this>) => void
107 * Worker node interface.
109 * @typeParam Worker - Type of worker.
110 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
113 export interface WorkerNode
<Worker
extends IWorker
, Data
= unknown
> {
115 * Worker node worker.
117 readonly worker
: Worker
119 * Worker node tasks usage statistics.
121 tasksUsage
: TasksUsage
123 * Worker node tasks queue.
125 readonly tasksQueue
: Array<Task
<Data
>>