1 import type { CircularArray
} from
'../circular-array'
2 import type { Queue
} from
'../queue'
5 * Callback invoked if the worker has received a message.
7 export type MessageHandler
<Worker
extends IWorker
> = (
13 * Callback invoked if the worker raised an error.
15 export type ErrorHandler
<Worker
extends IWorker
> = (
21 * Callback invoked when the worker has started successfully.
23 export type OnlineHandler
<Worker
extends IWorker
> = (this: Worker
) => void
26 * Callback invoked when the worker exits successfully.
28 export type ExitHandler
<Worker
extends IWorker
> = (
34 * Message object that is passed as a task between main worker and worker.
36 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
39 export interface Task
<Data
= unknown
> {
43 readonly name
?: string
45 * Task input data that will be passed to the worker.
55 * Worker tasks usage statistics.
59 export interface TasksUsage
{
61 * Number of tasks executed.
65 * Number of tasks running.
73 * Tasks runtime history.
75 runTimeHistory
: CircularArray
<number>
77 * Average tasks runtime.
81 * Median tasks runtime.
85 * Number of tasks errored.
93 export interface IWorker
{
95 * Register an event listener.
97 * @param event - The event.
98 * @param handler - The event handler.
100 on
: ((event
: 'message', handler
: MessageHandler
<this>) => void) &
101 ((event
: 'error', handler
: ErrorHandler
<this>) => void) &
102 ((event
: 'online', handler
: OnlineHandler
<this>) => void) &
103 ((event
: 'exit', handler
: ExitHandler
<this>) => void)
105 * Register a listener to the exit event that will only be performed once.
107 * @param event - `'exit'`.
108 * @param handler - The exit handler.
110 once
: (event
: 'exit', handler
: ExitHandler
<this>) => void
114 * Worker node interface.
116 * @typeParam Worker - Type of worker.
117 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
120 export interface WorkerNode
<Worker
extends IWorker
, Data
= unknown
> {
122 * Worker node worker.
124 readonly worker
: Worker
126 * Worker node tasks usage statistics.
128 tasksUsage
: TasksUsage
130 * Worker node tasks queue.
132 readonly tasksQueue
: Queue
<Task
<Data
>>