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
> {
42 readonly name
?: string
44 * Task input data that will be passed to the worker.
48 * UUID of the message.
54 * Worker tasks usage statistics.
58 export interface TasksUsage
{
60 * Number of tasks executed.
64 * Number of tasks running.
72 * Tasks runtime history.
74 runTimeHistory
: CircularArray
<number>
76 * Average tasks runtime.
80 * Median tasks runtime.
84 * Number of tasks errored.
92 export interface IWorker
{
94 * Register an event listener.
96 * @param event - The event.
97 * @param handler - The event handler.
99 on
: ((event
: 'message', handler
: MessageHandler
<this>) => void) &
100 ((event
: 'error', handler
: ErrorHandler
<this>) => void) &
101 ((event
: 'online', handler
: OnlineHandler
<this>) => void) &
102 ((event
: 'exit', handler
: ExitHandler
<this>) => void)
104 * Register a listener to the exit event that will only be performed once.
106 * @param event - `'exit'`.
107 * @param handler - The exit handler.
109 once
: (event
: 'exit', handler
: ExitHandler
<this>) => void
113 * Worker node interface.
115 * @typeParam Worker - Type of worker.
116 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
119 export interface WorkerNode
<Worker
extends IWorker
, Data
= unknown
> {
121 * Worker node worker.
123 readonly worker
: Worker
125 * Worker node tasks usage statistics.
127 tasksUsage
: TasksUsage
129 * Worker node tasks queue.
131 readonly tasksQueue
: Array<Task
<Data
>>