Commit | Line | Data |
---|---|---|
f06e48d8 | 1 | import type { CircularArray } from '../circular-array' |
29ee7e9a | 2 | import type { Queue } from '../queue' |
f06e48d8 | 3 | |
bdaf31cd JB |
4 | /** |
5 | * Callback invoked if the worker has received a message. | |
6 | */ | |
50e66724 JB |
7 | export type MessageHandler<Worker extends IWorker> = ( |
8 | this: Worker, | |
9 | m: unknown | |
10 | ) => void | |
bdaf31cd JB |
11 | |
12 | /** | |
13 | * Callback invoked if the worker raised an error. | |
14 | */ | |
50e66724 JB |
15 | export type ErrorHandler<Worker extends IWorker> = ( |
16 | this: Worker, | |
17 | e: Error | |
18 | ) => void | |
bdaf31cd JB |
19 | |
20 | /** | |
21 | * Callback invoked when the worker has started successfully. | |
22 | */ | |
50e66724 | 23 | export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void |
bdaf31cd JB |
24 | |
25 | /** | |
26 | * Callback invoked when the worker exits successfully. | |
27 | */ | |
50e66724 JB |
28 | export type ExitHandler<Worker extends IWorker> = ( |
29 | this: Worker, | |
30 | code: number | |
31 | ) => void | |
bdaf31cd JB |
32 | |
33 | /** | |
02706357 | 34 | * Message object that is passed as a task between main worker and worker. |
c319c66b JB |
35 | * |
36 | * @typeParam Data - Type of data sent to the worker. This can only be serializable data. | |
37 | * @internal | |
bdaf31cd | 38 | */ |
f06e48d8 | 39 | export interface Task<Data = unknown> { |
0274ce2d | 40 | /** |
d29bce7c | 41 | * Task input data that will be passed to the worker. |
0274ce2d | 42 | */ |
02706357 | 43 | readonly data?: Data |
0274ce2d | 44 | /** |
02706357 | 45 | * UUID of the message. |
0274ce2d | 46 | */ |
02706357 | 47 | readonly id?: string |
f06e48d8 JB |
48 | } |
49 | ||
50 | /** | |
51 | * Worker tasks usage statistics. | |
f9b4bbf8 JB |
52 | * |
53 | * @internal | |
f06e48d8 JB |
54 | */ |
55 | export interface TasksUsage { | |
02706357 JB |
56 | /** |
57 | * Number of tasks executed. | |
58 | */ | |
f06e48d8 | 59 | run: number |
02706357 JB |
60 | /** |
61 | * Number of tasks running. | |
62 | */ | |
f06e48d8 | 63 | running: number |
02706357 JB |
64 | /** |
65 | * Tasks runtime. | |
66 | */ | |
f06e48d8 | 67 | runTime: number |
02706357 JB |
68 | /** |
69 | * Tasks runtime history. | |
70 | */ | |
f06e48d8 | 71 | runTimeHistory: CircularArray<number> |
02706357 JB |
72 | /** |
73 | * Average tasks runtime. | |
74 | */ | |
f06e48d8 | 75 | avgRunTime: number |
02706357 JB |
76 | /** |
77 | * Median tasks runtime. | |
78 | */ | |
f06e48d8 | 79 | medRunTime: number |
02706357 JB |
80 | /** |
81 | * Number of tasks errored. | |
82 | */ | |
f06e48d8 JB |
83 | error: number |
84 | } | |
85 | ||
86 | /** | |
87 | * Worker interface. | |
88 | */ | |
89 | export interface IWorker { | |
bdaf31cd | 90 | /** |
78cea37e | 91 | * Register an event listener. |
bdaf31cd | 92 | * |
38e795c1 | 93 | * @param event - The event. |
48ef9107 | 94 | * @param handler - The event handler. |
bdaf31cd | 95 | */ |
78cea37e JB |
96 | on: ((event: 'message', handler: MessageHandler<this>) => void) & |
97 | ((event: 'error', handler: ErrorHandler<this>) => void) & | |
98 | ((event: 'online', handler: OnlineHandler<this>) => void) & | |
99 | ((event: 'exit', handler: ExitHandler<this>) => void) | |
bdaf31cd | 100 | /** |
7d6b5ad2 | 101 | * Register a listener to the exit event that will only be performed once. |
bdaf31cd | 102 | * |
38e795c1 JB |
103 | * @param event - `'exit'`. |
104 | * @param handler - The exit handler. | |
bdaf31cd | 105 | */ |
78cea37e | 106 | once: (event: 'exit', handler: ExitHandler<this>) => void |
bdaf31cd | 107 | } |
f06e48d8 JB |
108 | |
109 | /** | |
110 | * Worker node interface. | |
c319c66b JB |
111 | * |
112 | * @typeParam Worker - Type of worker. | |
113 | * @typeParam Data - Type of data sent to the worker. This can only be serializable data. | |
114 | * @internal | |
f06e48d8 JB |
115 | */ |
116 | export interface WorkerNode<Worker extends IWorker, Data = unknown> { | |
c319c66b JB |
117 | /** |
118 | * Worker node worker. | |
119 | */ | |
02706357 | 120 | readonly worker: Worker |
c319c66b JB |
121 | /** |
122 | * Worker node tasks usage statistics. | |
123 | */ | |
f06e48d8 | 124 | tasksUsage: TasksUsage |
c319c66b JB |
125 | /** |
126 | * Worker node tasks queue. | |
127 | */ | |
29ee7e9a | 128 | readonly tasksQueue: Queue<Task<Data>> |
f06e48d8 | 129 | } |