Commit | Line | Data |
---|---|---|
62c15a68 | 1 | import type { EventLoopUtilization } from 'node:perf_hooks' |
85aeb3f3 | 2 | import type { MessagePort } from 'node:worker_threads' |
1a81f8af | 3 | import type { KillBehavior } from './worker/worker-options' |
838898f1 | 4 | |
213e817d JB |
5 | /** |
6 | * Task error. | |
7 | * | |
e102732c | 8 | * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data. |
213e817d | 9 | */ |
82f36766 | 10 | export interface TaskError<Data = unknown> { |
ff128cc9 JB |
11 | /** |
12 | * Task name triggering the error. | |
13 | */ | |
14 | readonly name: string | |
82f36766 JB |
15 | /** |
16 | * Error message. | |
17 | */ | |
eb7bf744 | 18 | readonly message: string |
82f36766 | 19 | /** |
ff128cc9 | 20 | * Data triggering the error. |
82f36766 | 21 | */ |
eb7bf744 | 22 | readonly data?: Data |
82f36766 JB |
23 | } |
24 | ||
d715b7bc JB |
25 | /** |
26 | * Task performance. | |
f03062df JB |
27 | * |
28 | * @internal | |
d715b7bc JB |
29 | */ |
30 | export interface TaskPerformance { | |
197b4aa5 JB |
31 | /** |
32 | * Task name. | |
33 | */ | |
34 | readonly name: string | |
d715b7bc JB |
35 | /** |
36 | * Task performance timestamp. | |
37 | */ | |
eb7bf744 | 38 | readonly timestamp: number |
d715b7bc JB |
39 | /** |
40 | * Task runtime. | |
41 | */ | |
eb7bf744 | 42 | readonly runTime?: number |
d715b7bc JB |
43 | /** |
44 | * Task event loop utilization. | |
45 | */ | |
eb7bf744 | 46 | readonly elu?: EventLoopUtilization |
d715b7bc JB |
47 | } |
48 | ||
b6b32453 JB |
49 | /** |
50 | * Performance statistics computation. | |
f03062df JB |
51 | * |
52 | * @internal | |
b6b32453 JB |
53 | */ |
54 | export interface WorkerStatistics { | |
55 | runTime: boolean | |
b6b32453 JB |
56 | elu: boolean |
57 | } | |
58 | ||
5c4d16da JB |
59 | /** |
60 | * Message object that is passed as a task between main worker and worker. | |
61 | * | |
62 | * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. | |
63 | * @internal | |
64 | */ | |
65 | export interface Task<Data = unknown> { | |
66 | /** | |
67 | * Worker id. | |
68 | */ | |
69 | readonly workerId: number | |
70 | /** | |
71 | * Task name. | |
72 | */ | |
73 | readonly name?: string | |
74 | /** | |
75 | * Task input data that will be passed to the worker. | |
76 | */ | |
77 | readonly data?: Data | |
78 | /** | |
79 | * Timestamp. | |
80 | */ | |
81 | readonly timestamp?: number | |
82 | /** | |
83 | * Message UUID. | |
84 | */ | |
85 | readonly id?: string | |
86 | } | |
87 | ||
729c563d | 88 | /** |
02706357 | 89 | * Message object that is passed between main worker and worker. |
c319c66b | 90 | * |
e102732c JB |
91 | * @typeParam Data - Type of data sent to the worker or execution response. This can only be structured-cloneable data. |
92 | * @typeParam ErrorData - Type of data sent to the worker triggering an error. This can only be structured-cloneable data. | |
71ebe93b | 93 | * @internal |
729c563d | 94 | */ |
6677a3d3 JB |
95 | export interface MessageValue<Data = unknown, ErrorData = unknown> |
96 | extends Task<Data> { | |
729c563d S |
97 | /** |
98 | * Kill code. | |
99 | */ | |
48487131 | 100 | readonly kill?: KillBehavior | true |
729c563d | 101 | /** |
91ee39ed | 102 | * Task error. |
729c563d | 103 | */ |
e102732c | 104 | readonly taskError?: TaskError<ErrorData> |
bf9549ae | 105 | /** |
d715b7bc | 106 | * Task performance. |
62c15a68 | 107 | */ |
d715b7bc | 108 | readonly taskPerformance?: TaskPerformance |
b6b32453 | 109 | /** |
f59e1027 | 110 | * Whether the worker computes the given statistics or not. |
b6b32453 JB |
111 | */ |
112 | readonly statistics?: WorkerStatistics | |
f59e1027 | 113 | /** |
7c8381eb | 114 | * Whether the worker is ready or not. |
f59e1027 | 115 | */ |
7c8381eb | 116 | readonly ready?: boolean |
75d3401a | 117 | /** |
b0a4db63 | 118 | * Whether the worker starts or stops its activity check. |
75d3401a | 119 | */ |
b0a4db63 | 120 | readonly checkActive?: boolean |
85aeb3f3 JB |
121 | /** |
122 | * Message port. | |
123 | */ | |
124 | readonly port?: MessagePort | |
325f50bc | 125 | } |
be0676b3 APA |
126 | |
127 | /** | |
e5d3809a | 128 | * An object holding the task execution response promise resolve/reject callbacks. |
be0676b3 | 129 | * |
e102732c | 130 | * @typeParam Response - Type of execution response. This can only be structured-cloneable data. |
c319c66b | 131 | * @internal |
be0676b3 | 132 | */ |
501aea93 | 133 | export interface PromiseResponseWrapper<Response = unknown> { |
be0676b3 APA |
134 | /** |
135 | * Resolve callback to fulfill the promise. | |
136 | */ | |
d2c73f82 | 137 | readonly resolve: (value: Response | PromiseLike<Response>) => void |
be0676b3 APA |
138 | /** |
139 | * Reject callback to reject the promise. | |
140 | */ | |
d2c73f82 | 141 | readonly reject: (reason?: unknown) => void |
be0676b3 | 142 | /** |
e5d3809a | 143 | * The worker node key executing the task. |
be0676b3 | 144 | */ |
501aea93 | 145 | readonly workerNodeKey: number |
be0676b3 | 146 | } |