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