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.
49 * Submission timestamp.
51 readonly submissionTimestamp
?: number
59 * Worker tasks usage statistics.
63 export interface TasksUsage
{
65 * Number of tasks executed.
69 * Number of tasks running.
77 * Tasks runtime history.
79 runTimeHistory
: CircularArray
<number>
81 * Average tasks runtime.
85 * Median tasks runtime.
93 * Tasks wait time history.
95 waitTimeHistory
: CircularArray
<number>
97 * Average tasks wait time.
101 * Median tasks wait time.
105 * Number of tasks errored.
113 export interface IWorker
{
115 * Register an event listener.
117 * @param event - The event.
118 * @param handler - The event handler.
120 on
: ((event
: 'message', handler
: MessageHandler
<this>) => void) &
121 ((event
: 'error', handler
: ErrorHandler
<this>) => void) &
122 ((event
: 'online', handler
: OnlineHandler
<this>) => void) &
123 ((event
: 'exit', handler
: ExitHandler
<this>) => void)
125 * Register a listener to the exit event that will only be performed once.
127 * @param event - `'exit'`.
128 * @param handler - The exit handler.
130 once
: (event
: 'exit', handler
: ExitHandler
<this>) => void
134 * Worker node interface.
136 * @typeParam Worker - Type of worker.
137 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
140 export interface WorkerNode
<Worker
extends IWorker
, Data
= unknown
> {
142 * Worker node worker.
144 readonly worker
: Worker
146 * Worker node tasks usage statistics.
148 tasksUsage
: TasksUsage
150 * Worker node tasks queue.
152 readonly tasksQueue
: Queue
<Task
<Data
>>