@breautek/storm 5.0.1 → 6.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (204) hide show
  1. package/CHANGELOG.md +24 -2
  2. package/bt-config-defaults.json +0 -1
  3. package/bt-config-sample.jsonc +41 -7
  4. package/docs/assets/highlight.css +92 -0
  5. package/docs/assets/main.js +58 -0
  6. package/docs/assets/search.js +1 -0
  7. package/docs/assets/style.css +1367 -0
  8. package/docs/classes/Application.html +1278 -0
  9. package/docs/classes/BackendAuthenticationMiddleware.html +193 -0
  10. package/docs/classes/CORSMiddleware.html +259 -0
  11. package/docs/classes/ConfigLoader.html +168 -0
  12. package/docs/classes/Database.html +342 -0
  13. package/docs/classes/DatabaseCastObject.html +205 -0
  14. package/docs/classes/DatabaseConnection.html +552 -0
  15. package/docs/classes/DatabaseQueryError.html +374 -0
  16. package/docs/classes/DeadLockError.html +374 -0
  17. package/docs/classes/DiskSpaceError.html +364 -0
  18. package/docs/classes/DropTemporaryTableQuery.html +287 -0
  19. package/docs/classes/DuplicateEntryError.html +368 -0
  20. package/docs/classes/EntityNotFoundError.html +364 -0
  21. package/docs/classes/ExpiredTokenError.html +364 -0
  22. package/docs/classes/Handler.html +397 -0
  23. package/docs/classes/InternalError.html +364 -0
  24. package/docs/classes/InvalidCredentialsError.html +364 -0
  25. package/docs/classes/InvalidValueError.html +375 -0
  26. package/docs/classes/LineString.html +214 -0
  27. package/docs/classes/LockWaitTimeoutError.html +374 -0
  28. package/docs/classes/ManagedDatabaseConnection.html +412 -0
  29. package/docs/classes/Middleware.html +204 -0
  30. package/docs/classes/MissingConfigError.html +364 -0
  31. package/docs/classes/MissingParameterError.html +364 -0
  32. package/docs/classes/MySQLConnection.html +548 -0
  33. package/docs/classes/MySQLDatabase.html +355 -0
  34. package/docs/classes/NotImplementedError.html +364 -0
  35. package/docs/classes/Point.html +216 -0
  36. package/docs/classes/Polygon.html +214 -0
  37. package/docs/classes/Query.html +314 -0
  38. package/docs/classes/RawError.html +376 -0
  39. package/docs/classes/RawQuery.html +307 -0
  40. package/docs/classes/Request.html +377 -0
  41. package/docs/classes/Response.html +331 -0
  42. package/docs/classes/ResponseData.html +257 -0
  43. package/docs/classes/ServiceProvider.html +387 -0
  44. package/docs/classes/ServiceResponse.html +215 -0
  45. package/docs/classes/SetSessionVariableQuery.html +287 -0
  46. package/docs/classes/StormError.html +379 -0
  47. package/docs/classes/TemporaryTableQuery.html +292 -0
  48. package/docs/classes/Token.html +183 -0
  49. package/docs/classes/TokenManager.html +235 -0
  50. package/docs/classes/Transaction.html +269 -0
  51. package/docs/classes/UnauthorizedAccessError.html +364 -0
  52. package/docs/enums/ErrorCode.html +212 -0
  53. package/docs/enums/ExitCode.html +163 -0
  54. package/docs/enums/HTTPMethod.html +177 -0
  55. package/docs/enums/IsolationLevel.html +177 -0
  56. package/docs/enums/JWTError.html +163 -0
  57. package/docs/enums/StatusCode.html +485 -0
  58. package/docs/functions/formidable-1.html +145 -0
  59. package/docs/functions/getInstance.html +140 -0
  60. package/docs/index.html +228 -0
  61. package/docs/interfaces/IAdditionalErrorDetails.html +142 -0
  62. package/docs/interfaces/IAuthTokenData.html +174 -0
  63. package/docs/interfaces/ICloudwatchConfig.html +174 -0
  64. package/docs/interfaces/ICloudwatchCredentials.html +167 -0
  65. package/docs/interfaces/ICloudwatchStreamConfig.html +167 -0
  66. package/docs/interfaces/IConfig.html +227 -0
  67. package/docs/interfaces/IDatabaseConfig.html +200 -0
  68. package/docs/interfaces/IDatabaseConnection.html +334 -0
  69. package/docs/interfaces/IErrorResponse.html +188 -0
  70. package/docs/interfaces/IFormData.html +167 -0
  71. package/docs/interfaces/IHandler.html +173 -0
  72. package/docs/interfaces/IInsertQueryResult.html +174 -0
  73. package/docs/interfaces/IJWTVerifyOptions.html +160 -0
  74. package/docs/interfaces/IParameterMap.html +142 -0
  75. package/docs/interfaces/IQueryable.html +235 -0
  76. package/docs/interfaces/IRequestResponse.html +174 -0
  77. package/docs/interfaces/IServiceHeaders.html +142 -0
  78. package/docs/interfaces/ISetSessionVariableQueryInput.html +167 -0
  79. package/docs/interfaces/ITemporaryTableQueryInput.html +167 -0
  80. package/docs/interfaces/IUpdateQueryResult.html +167 -0
  81. package/docs/interfaces/formidable.EmitData.html +182 -0
  82. package/docs/interfaces/formidable.EventData.html +203 -0
  83. package/docs/interfaces/formidable.Fields.html +143 -0
  84. package/docs/interfaces/formidable.File.html +241 -0
  85. package/docs/interfaces/formidable.FileJSON.html +240 -0
  86. package/docs/interfaces/formidable.Files.html +143 -0
  87. package/docs/interfaces/formidable.Options.html +310 -0
  88. package/docs/interfaces/formidable.Part.html +693 -0
  89. package/docs/modules/formidable.html +161 -0
  90. package/docs/types/IDeleteQueryResult.html +136 -0
  91. package/docs/types/IHandlerError.html +141 -0
  92. package/docs/types/IHandlerResponse.html +147 -0
  93. package/docs/types/TCoordinate.html +136 -0
  94. package/docs/types/formidable.BufferEncoding.html +137 -0
  95. package/docs/types/formidable.DefaultOptions.html +137 -0
  96. package/docs/types/formidable.EnabledPlugins.html +137 -0
  97. package/docs/types/formidable.EventNames.html +137 -0
  98. package/docs/types/formidable.MappedParsers.html +137 -0
  99. package/docs/types/formidable.Plugin.html +137 -0
  100. package/docs/types/formidable.PluginFunction.html +152 -0
  101. package/docs/types/formidable.Plugins.html +137 -0
  102. package/lib/Application.d.ts +3 -0
  103. package/lib/Application.js +105 -63
  104. package/lib/Application.js.map +1 -1
  105. package/lib/IConfig.d.ts +15 -2
  106. package/lib/MySQLConnection.js +3 -3
  107. package/lib/MySQLConnection.js.map +1 -1
  108. package/lib/StatusCode.d.ts +1 -1
  109. package/lib/StatusCode.js +1 -1
  110. package/lib/Transaction.d.ts +4 -0
  111. package/lib/Transaction.js +4 -0
  112. package/lib/Transaction.js.map +1 -1
  113. package/lib/api.d.ts +1 -2
  114. package/lib/api.js +2 -4
  115. package/lib/api.js.map +1 -1
  116. package/package.json +18 -16
  117. package/src/Application.ts +131 -68
  118. package/src/IConfig.ts +18 -2
  119. package/src/MySQLConnection.ts +2 -1
  120. package/src/StatusCode.ts +1 -1
  121. package/src/Transaction.ts +4 -0
  122. package/src/api.ts +6 -2
  123. package/docs/README.md +0 -188
  124. package/docs/classes/Application.md +0 -1648
  125. package/docs/classes/BackendAuthenticationMiddleware.md +0 -49
  126. package/docs/classes/CORSMiddleware.md +0 -143
  127. package/docs/classes/ConfigLoader.md +0 -29
  128. package/docs/classes/Database.md +0 -259
  129. package/docs/classes/DatabaseCastObject.md +0 -79
  130. package/docs/classes/DatabaseConnection.md +0 -556
  131. package/docs/classes/DatabaseQueryError.md +0 -351
  132. package/docs/classes/DeadLockError.md +0 -349
  133. package/docs/classes/DiskSpaceError.md +0 -341
  134. package/docs/classes/DropTemporaryTableQuery.md +0 -207
  135. package/docs/classes/DumpStream.md +0 -23
  136. package/docs/classes/DuplicateEntryError.md +0 -343
  137. package/docs/classes/EntityNotFoundError.md +0 -341
  138. package/docs/classes/ExpiredTokenError.md +0 -341
  139. package/docs/classes/Handler.md +0 -302
  140. package/docs/classes/InternalError.md +0 -341
  141. package/docs/classes/InvalidCredentialsError.md +0 -341
  142. package/docs/classes/InvalidValueError.md +0 -349
  143. package/docs/classes/LineString.md +0 -101
  144. package/docs/classes/LockWaitTimeoutError.md +0 -349
  145. package/docs/classes/ManagedDatabaseConnection.md +0 -403
  146. package/docs/classes/Middleware.md +0 -72
  147. package/docs/classes/MissingConfigError.md +0 -341
  148. package/docs/classes/MissingParameterError.md +0 -341
  149. package/docs/classes/MySQLConnection.md +0 -569
  150. package/docs/classes/MySQLDatabase.md +0 -314
  151. package/docs/classes/NotImplementedError.md +0 -341
  152. package/docs/classes/Point.md +0 -102
  153. package/docs/classes/Polygon.md +0 -101
  154. package/docs/classes/Query.md +0 -227
  155. package/docs/classes/RawError.md +0 -351
  156. package/docs/classes/RawQuery.md +0 -224
  157. package/docs/classes/Request.md +0 -321
  158. package/docs/classes/Response.md +0 -242
  159. package/docs/classes/ResponseData.md +0 -144
  160. package/docs/classes/ServiceProvider.md +0 -296
  161. package/docs/classes/ServiceResponse.md +0 -89
  162. package/docs/classes/SetSessionVariableQuery.md +0 -207
  163. package/docs/classes/StormError.md +0 -343
  164. package/docs/classes/TemporaryTableQuery.md +0 -213
  165. package/docs/classes/Token.md +0 -43
  166. package/docs/classes/TokenManager.md +0 -105
  167. package/docs/classes/Transaction.md +0 -161
  168. package/docs/classes/UnauthorizedAccessError.md +0 -341
  169. package/docs/enums/ErrorCode.md +0 -107
  170. package/docs/enums/ExitCode.md +0 -30
  171. package/docs/enums/HTTPMethod.md +0 -52
  172. package/docs/enums/IsolationLevel.md +0 -52
  173. package/docs/enums/JWTError.md +0 -30
  174. package/docs/enums/StatusCode.md +0 -536
  175. package/docs/interfaces/IAdditionalErrorDetails.md +0 -7
  176. package/docs/interfaces/IAuthTokenData.md +0 -41
  177. package/docs/interfaces/IConfig.md +0 -112
  178. package/docs/interfaces/IDatabaseConfig.md +0 -80
  179. package/docs/interfaces/IDatabaseConnection.md +0 -262
  180. package/docs/interfaces/IErrorResponse.md +0 -63
  181. package/docs/interfaces/IFormData.md +0 -30
  182. package/docs/interfaces/IHandler.md +0 -31
  183. package/docs/interfaces/IInsertQueryResult.md +0 -41
  184. package/docs/interfaces/IJWTVerifyOptions.md +0 -19
  185. package/docs/interfaces/IParameterMap.md +0 -7
  186. package/docs/interfaces/IQueryable.md +0 -119
  187. package/docs/interfaces/IRequestResponse.md +0 -37
  188. package/docs/interfaces/IServiceHeaders.md +0 -7
  189. package/docs/interfaces/ISetSessionVariableQueryInput.md +0 -30
  190. package/docs/interfaces/ITemporaryTableQueryInput.md +0 -30
  191. package/docs/interfaces/IUpdateQueryResult.md +0 -30
  192. package/docs/interfaces/formidable.EmitData.md +0 -54
  193. package/docs/interfaces/formidable.EventData.md +0 -87
  194. package/docs/interfaces/formidable.Fields.md +0 -9
  195. package/docs/interfaces/formidable.File.md +0 -131
  196. package/docs/interfaces/formidable.FileJSON.md +0 -151
  197. package/docs/interfaces/formidable.Files.md +0 -9
  198. package/docs/interfaces/formidable.Options.md +0 -225
  199. package/docs/interfaces/formidable.Part.md +0 -793
  200. package/docs/modules/formidable.md +0 -122
  201. package/lib/DumpStream.d.ts +0 -6
  202. package/lib/DumpStream.js +0 -28
  203. package/lib/DumpStream.js.map +0 -1
  204. package/src/DumpStream.ts +0 -28
@@ -1,351 +0,0 @@
1
- [@breautek/storm](../README.md) / DatabaseQueryError
2
-
3
- # Class: DatabaseQueryError
4
-
5
- ## Hierarchy
6
-
7
- - [`StormError`](StormError.md)<{ `error`: `any` ; `query`: `string` }\>
8
-
9
- ↳ **`DatabaseQueryError`**
10
-
11
- ↳↳ [`DeadLockError`](DeadLockError.md)
12
-
13
- ↳↳ [`LockWaitTimeoutError`](LockWaitTimeoutError.md)
14
-
15
- ## Table of contents
16
-
17
- ### Constructors
18
-
19
- - [constructor](DatabaseQueryError.md#constructor)
20
-
21
- ### Properties
22
-
23
- - [message](DatabaseQueryError.md#message)
24
- - [name](DatabaseQueryError.md#name)
25
- - [stack](DatabaseQueryError.md#stack)
26
- - [prepareStackTrace](DatabaseQueryError.md#preparestacktrace)
27
- - [stackTraceLimit](DatabaseQueryError.md#stacktracelimit)
28
-
29
- ### Methods
30
-
31
- - [getCode](DatabaseQueryError.md#getcode)
32
- - [getErrorResponse](DatabaseQueryError.md#geterrorresponse)
33
- - [getExitCode](DatabaseQueryError.md#getexitcode)
34
- - [getHTTPCode](DatabaseQueryError.md#gethttpcode)
35
- - [getLocaleCode](DatabaseQueryError.md#getlocalecode)
36
- - [getLocaleParameters](DatabaseQueryError.md#getlocaleparameters)
37
- - [getMessage](DatabaseQueryError.md#getmessage)
38
- - [getPrivateDetails](DatabaseQueryError.md#getprivatedetails)
39
- - [getPublicDetails](DatabaseQueryError.md#getpublicdetails)
40
- - [captureStackTrace](DatabaseQueryError.md#capturestacktrace)
41
-
42
- ## Constructors
43
-
44
- ### constructor
45
-
46
- • **new DatabaseQueryError**(`query`, `error`)
47
-
48
- #### Parameters
49
-
50
- | Name | Type |
51
- | :------ | :------ |
52
- | `query` | `string` |
53
- | `error` | `any` |
54
-
55
- #### Overrides
56
-
57
- [StormError](StormError.md).[constructor](StormError.md#constructor)
58
-
59
- #### Defined in
60
-
61
- [src/DatabaseQueryError.ts:25](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseQueryError.ts#L25)
62
-
63
- ## Properties
64
-
65
- ### message
66
-
67
- • **message**: `string`
68
-
69
- #### Inherited from
70
-
71
- [StormError](StormError.md).[message](StormError.md#message)
72
-
73
- #### Defined in
74
-
75
- node_modules/typescript/lib/lib.es5.d.ts:1054
76
-
77
- ___
78
-
79
- ### name
80
-
81
- • **name**: `string`
82
-
83
- #### Inherited from
84
-
85
- [StormError](StormError.md).[name](StormError.md#name)
86
-
87
- #### Defined in
88
-
89
- node_modules/typescript/lib/lib.es5.d.ts:1053
90
-
91
- ___
92
-
93
- ### stack
94
-
95
- • `Optional` **stack**: `string`
96
-
97
- #### Inherited from
98
-
99
- [StormError](StormError.md).[stack](StormError.md#stack)
100
-
101
- #### Defined in
102
-
103
- node_modules/typescript/lib/lib.es5.d.ts:1055
104
-
105
- ___
106
-
107
- ### prepareStackTrace
108
-
109
- ▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
110
-
111
- #### Type declaration
112
-
113
- ▸ (`err`, `stackTraces`): `any`
114
-
115
- Optional override for formatting stack traces
116
-
117
- **`See`**
118
-
119
- https://v8.dev/docs/stack-trace-api#customizing-stack-traces
120
-
121
- ##### Parameters
122
-
123
- | Name | Type |
124
- | :------ | :------ |
125
- | `err` | `Error` |
126
- | `stackTraces` | `CallSite`[] |
127
-
128
- ##### Returns
129
-
130
- `any`
131
-
132
- #### Inherited from
133
-
134
- [StormError](StormError.md).[prepareStackTrace](StormError.md#preparestacktrace)
135
-
136
- #### Defined in
137
-
138
- node_modules/@types/node/globals.d.ts:11
139
-
140
- ___
141
-
142
- ### stackTraceLimit
143
-
144
- ▪ `Static` **stackTraceLimit**: `number`
145
-
146
- #### Inherited from
147
-
148
- [StormError](StormError.md).[stackTraceLimit](StormError.md#stacktracelimit)
149
-
150
- #### Defined in
151
-
152
- node_modules/@types/node/globals.d.ts:13
153
-
154
- ## Methods
155
-
156
- ### getCode
157
-
158
- ▸ **getCode**(): `number`
159
-
160
- #### Returns
161
-
162
- `number`
163
-
164
- #### Overrides
165
-
166
- [StormError](StormError.md).[getCode](StormError.md#getcode)
167
-
168
- #### Defined in
169
-
170
- [src/DatabaseQueryError.ts:36](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseQueryError.ts#L36)
171
-
172
- ___
173
-
174
- ### getErrorResponse
175
-
176
- ▸ **getErrorResponse**(): [`IErrorResponse`](../interfaces/IErrorResponse.md)
177
-
178
- #### Returns
179
-
180
- [`IErrorResponse`](../interfaces/IErrorResponse.md)
181
-
182
- #### Inherited from
183
-
184
- [StormError](StormError.md).[getErrorResponse](StormError.md#geterrorresponse)
185
-
186
- #### Defined in
187
-
188
- [src/StormError.ts:76](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L76)
189
-
190
- ___
191
-
192
- ### getExitCode
193
-
194
- ▸ **getExitCode**(): [`ExitCode`](../enums/ExitCode.md)
195
-
196
- #### Returns
197
-
198
- [`ExitCode`](../enums/ExitCode.md)
199
-
200
- #### Inherited from
201
-
202
- [StormError](StormError.md).[getExitCode](StormError.md#getexitcode)
203
-
204
- #### Defined in
205
-
206
- [src/StormError.ts:97](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L97)
207
-
208
- ___
209
-
210
- ### getHTTPCode
211
-
212
- ▸ **getHTTPCode**(): [`StatusCode`](../enums/StatusCode.md)
213
-
214
- #### Returns
215
-
216
- [`StatusCode`](../enums/StatusCode.md)
217
-
218
- #### Overrides
219
-
220
- [StormError](StormError.md).[getHTTPCode](StormError.md#gethttpcode)
221
-
222
- #### Defined in
223
-
224
- [src/DatabaseQueryError.ts:40](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseQueryError.ts#L40)
225
-
226
- ___
227
-
228
- ### getLocaleCode
229
-
230
- ▸ **getLocaleCode**(): `string`
231
-
232
- #### Returns
233
-
234
- `string`
235
-
236
- #### Overrides
237
-
238
- [StormError](StormError.md).[getLocaleCode](StormError.md#getlocalecode)
239
-
240
- #### Defined in
241
-
242
- [src/DatabaseQueryError.ts:44](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseQueryError.ts#L44)
243
-
244
- ___
245
-
246
- ### getLocaleParameters
247
-
248
- ▸ **getLocaleParameters**(): `Record`<`string`, `string`\>
249
-
250
- #### Returns
251
-
252
- `Record`<`string`, `string`\>
253
-
254
- #### Inherited from
255
-
256
- [StormError](StormError.md).[getLocaleParameters](StormError.md#getlocaleparameters)
257
-
258
- #### Defined in
259
-
260
- [src/StormError.ts:93](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L93)
261
-
262
- ___
263
-
264
- ### getMessage
265
-
266
- ▸ **getMessage**(): `string`
267
-
268
- #### Returns
269
-
270
- `string`
271
-
272
- #### Overrides
273
-
274
- [StormError](StormError.md).[getMessage](StormError.md#getmessage)
275
-
276
- #### Defined in
277
-
278
- [src/DatabaseQueryError.ts:32](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseQueryError.ts#L32)
279
-
280
- ___
281
-
282
- ### getPrivateDetails
283
-
284
- ▸ **getPrivateDetails**(): `Object`
285
-
286
- Private details are only logged to the server log.
287
- They are kept secret from the client.
288
-
289
- #### Returns
290
-
291
- `Object`
292
-
293
- | Name | Type |
294
- | :------ | :------ |
295
- | `error` | `any` |
296
- | `query` | `string` |
297
-
298
- #### Inherited from
299
-
300
- [StormError](StormError.md).[getPrivateDetails](StormError.md#getprivatedetails)
301
-
302
- #### Defined in
303
-
304
- [src/StormError.ts:68](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L68)
305
-
306
- ___
307
-
308
- ### getPublicDetails
309
-
310
- ▸ **getPublicDetails**(): [`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
311
-
312
- Sends details to the client.
313
-
314
- #### Returns
315
-
316
- [`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
317
-
318
- #### Inherited from
319
-
320
- [StormError](StormError.md).[getPublicDetails](StormError.md#getpublicdetails)
321
-
322
- #### Defined in
323
-
324
- [src/StormError.ts:60](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L60)
325
-
326
- ___
327
-
328
- ### captureStackTrace
329
-
330
- ▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
331
-
332
- Create .stack property on a target object
333
-
334
- #### Parameters
335
-
336
- | Name | Type |
337
- | :------ | :------ |
338
- | `targetObject` | `object` |
339
- | `constructorOpt?` | `Function` |
340
-
341
- #### Returns
342
-
343
- `void`
344
-
345
- #### Inherited from
346
-
347
- [StormError](StormError.md).[captureStackTrace](StormError.md#capturestacktrace)
348
-
349
- #### Defined in
350
-
351
- node_modules/@types/node/globals.d.ts:4
@@ -1,349 +0,0 @@
1
- [@breautek/storm](../README.md) / DeadLockError
2
-
3
- # Class: DeadLockError
4
-
5
- DeadLockError is a DatabaseQueryError but is subclasses for typing purposes.
6
-
7
- ## Hierarchy
8
-
9
- - [`DatabaseQueryError`](DatabaseQueryError.md)
10
-
11
- ↳ **`DeadLockError`**
12
-
13
- ## Table of contents
14
-
15
- ### Constructors
16
-
17
- - [constructor](DeadLockError.md#constructor)
18
-
19
- ### Properties
20
-
21
- - [message](DeadLockError.md#message)
22
- - [name](DeadLockError.md#name)
23
- - [stack](DeadLockError.md#stack)
24
- - [prepareStackTrace](DeadLockError.md#preparestacktrace)
25
- - [stackTraceLimit](DeadLockError.md#stacktracelimit)
26
-
27
- ### Methods
28
-
29
- - [getCode](DeadLockError.md#getcode)
30
- - [getErrorResponse](DeadLockError.md#geterrorresponse)
31
- - [getExitCode](DeadLockError.md#getexitcode)
32
- - [getHTTPCode](DeadLockError.md#gethttpcode)
33
- - [getLocaleCode](DeadLockError.md#getlocalecode)
34
- - [getLocaleParameters](DeadLockError.md#getlocaleparameters)
35
- - [getMessage](DeadLockError.md#getmessage)
36
- - [getPrivateDetails](DeadLockError.md#getprivatedetails)
37
- - [getPublicDetails](DeadLockError.md#getpublicdetails)
38
- - [captureStackTrace](DeadLockError.md#capturestacktrace)
39
-
40
- ## Constructors
41
-
42
- ### constructor
43
-
44
- • **new DeadLockError**(`query`, `error`)
45
-
46
- #### Parameters
47
-
48
- | Name | Type |
49
- | :------ | :------ |
50
- | `query` | `string` |
51
- | `error` | `any` |
52
-
53
- #### Inherited from
54
-
55
- [DatabaseQueryError](DatabaseQueryError.md).[constructor](DatabaseQueryError.md#constructor)
56
-
57
- #### Defined in
58
-
59
- [src/DatabaseQueryError.ts:25](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseQueryError.ts#L25)
60
-
61
- ## Properties
62
-
63
- ### message
64
-
65
- • **message**: `string`
66
-
67
- #### Inherited from
68
-
69
- [DatabaseQueryError](DatabaseQueryError.md).[message](DatabaseQueryError.md#message)
70
-
71
- #### Defined in
72
-
73
- node_modules/typescript/lib/lib.es5.d.ts:1054
74
-
75
- ___
76
-
77
- ### name
78
-
79
- • **name**: `string`
80
-
81
- #### Inherited from
82
-
83
- [DatabaseQueryError](DatabaseQueryError.md).[name](DatabaseQueryError.md#name)
84
-
85
- #### Defined in
86
-
87
- node_modules/typescript/lib/lib.es5.d.ts:1053
88
-
89
- ___
90
-
91
- ### stack
92
-
93
- • `Optional` **stack**: `string`
94
-
95
- #### Inherited from
96
-
97
- [DatabaseQueryError](DatabaseQueryError.md).[stack](DatabaseQueryError.md#stack)
98
-
99
- #### Defined in
100
-
101
- node_modules/typescript/lib/lib.es5.d.ts:1055
102
-
103
- ___
104
-
105
- ### prepareStackTrace
106
-
107
- ▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
108
-
109
- #### Type declaration
110
-
111
- ▸ (`err`, `stackTraces`): `any`
112
-
113
- Optional override for formatting stack traces
114
-
115
- **`See`**
116
-
117
- https://v8.dev/docs/stack-trace-api#customizing-stack-traces
118
-
119
- ##### Parameters
120
-
121
- | Name | Type |
122
- | :------ | :------ |
123
- | `err` | `Error` |
124
- | `stackTraces` | `CallSite`[] |
125
-
126
- ##### Returns
127
-
128
- `any`
129
-
130
- #### Inherited from
131
-
132
- [DatabaseQueryError](DatabaseQueryError.md).[prepareStackTrace](DatabaseQueryError.md#preparestacktrace)
133
-
134
- #### Defined in
135
-
136
- node_modules/@types/node/globals.d.ts:11
137
-
138
- ___
139
-
140
- ### stackTraceLimit
141
-
142
- ▪ `Static` **stackTraceLimit**: `number`
143
-
144
- #### Inherited from
145
-
146
- [DatabaseQueryError](DatabaseQueryError.md).[stackTraceLimit](DatabaseQueryError.md#stacktracelimit)
147
-
148
- #### Defined in
149
-
150
- node_modules/@types/node/globals.d.ts:13
151
-
152
- ## Methods
153
-
154
- ### getCode
155
-
156
- ▸ **getCode**(): `number`
157
-
158
- #### Returns
159
-
160
- `number`
161
-
162
- #### Inherited from
163
-
164
- [DatabaseQueryError](DatabaseQueryError.md).[getCode](DatabaseQueryError.md#getcode)
165
-
166
- #### Defined in
167
-
168
- [src/DatabaseQueryError.ts:36](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseQueryError.ts#L36)
169
-
170
- ___
171
-
172
- ### getErrorResponse
173
-
174
- ▸ **getErrorResponse**(): [`IErrorResponse`](../interfaces/IErrorResponse.md)
175
-
176
- #### Returns
177
-
178
- [`IErrorResponse`](../interfaces/IErrorResponse.md)
179
-
180
- #### Inherited from
181
-
182
- [DatabaseQueryError](DatabaseQueryError.md).[getErrorResponse](DatabaseQueryError.md#geterrorresponse)
183
-
184
- #### Defined in
185
-
186
- [src/StormError.ts:76](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L76)
187
-
188
- ___
189
-
190
- ### getExitCode
191
-
192
- ▸ **getExitCode**(): [`ExitCode`](../enums/ExitCode.md)
193
-
194
- #### Returns
195
-
196
- [`ExitCode`](../enums/ExitCode.md)
197
-
198
- #### Inherited from
199
-
200
- [DatabaseQueryError](DatabaseQueryError.md).[getExitCode](DatabaseQueryError.md#getexitcode)
201
-
202
- #### Defined in
203
-
204
- [src/StormError.ts:97](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L97)
205
-
206
- ___
207
-
208
- ### getHTTPCode
209
-
210
- ▸ **getHTTPCode**(): [`StatusCode`](../enums/StatusCode.md)
211
-
212
- #### Returns
213
-
214
- [`StatusCode`](../enums/StatusCode.md)
215
-
216
- #### Inherited from
217
-
218
- [DatabaseQueryError](DatabaseQueryError.md).[getHTTPCode](DatabaseQueryError.md#gethttpcode)
219
-
220
- #### Defined in
221
-
222
- [src/DatabaseQueryError.ts:40](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseQueryError.ts#L40)
223
-
224
- ___
225
-
226
- ### getLocaleCode
227
-
228
- ▸ **getLocaleCode**(): `string`
229
-
230
- #### Returns
231
-
232
- `string`
233
-
234
- #### Inherited from
235
-
236
- [DatabaseQueryError](DatabaseQueryError.md).[getLocaleCode](DatabaseQueryError.md#getlocalecode)
237
-
238
- #### Defined in
239
-
240
- [src/DatabaseQueryError.ts:44](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseQueryError.ts#L44)
241
-
242
- ___
243
-
244
- ### getLocaleParameters
245
-
246
- ▸ **getLocaleParameters**(): `Record`<`string`, `string`\>
247
-
248
- #### Returns
249
-
250
- `Record`<`string`, `string`\>
251
-
252
- #### Inherited from
253
-
254
- [DatabaseQueryError](DatabaseQueryError.md).[getLocaleParameters](DatabaseQueryError.md#getlocaleparameters)
255
-
256
- #### Defined in
257
-
258
- [src/StormError.ts:93](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L93)
259
-
260
- ___
261
-
262
- ### getMessage
263
-
264
- ▸ **getMessage**(): `string`
265
-
266
- #### Returns
267
-
268
- `string`
269
-
270
- #### Inherited from
271
-
272
- [DatabaseQueryError](DatabaseQueryError.md).[getMessage](DatabaseQueryError.md#getmessage)
273
-
274
- #### Defined in
275
-
276
- [src/DatabaseQueryError.ts:32](https://github.com/breautek/storm/blob/3dcafe4/src/DatabaseQueryError.ts#L32)
277
-
278
- ___
279
-
280
- ### getPrivateDetails
281
-
282
- ▸ **getPrivateDetails**(): `Object`
283
-
284
- Private details are only logged to the server log.
285
- They are kept secret from the client.
286
-
287
- #### Returns
288
-
289
- `Object`
290
-
291
- | Name | Type |
292
- | :------ | :------ |
293
- | `error` | `any` |
294
- | `query` | `string` |
295
-
296
- #### Inherited from
297
-
298
- [DatabaseQueryError](DatabaseQueryError.md).[getPrivateDetails](DatabaseQueryError.md#getprivatedetails)
299
-
300
- #### Defined in
301
-
302
- [src/StormError.ts:68](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L68)
303
-
304
- ___
305
-
306
- ### getPublicDetails
307
-
308
- ▸ **getPublicDetails**(): [`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
309
-
310
- Sends details to the client.
311
-
312
- #### Returns
313
-
314
- [`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
315
-
316
- #### Inherited from
317
-
318
- [DatabaseQueryError](DatabaseQueryError.md).[getPublicDetails](DatabaseQueryError.md#getpublicdetails)
319
-
320
- #### Defined in
321
-
322
- [src/StormError.ts:60](https://github.com/breautek/storm/blob/3dcafe4/src/StormError.ts#L60)
323
-
324
- ___
325
-
326
- ### captureStackTrace
327
-
328
- ▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
329
-
330
- Create .stack property on a target object
331
-
332
- #### Parameters
333
-
334
- | Name | Type |
335
- | :------ | :------ |
336
- | `targetObject` | `object` |
337
- | `constructorOpt?` | `Function` |
338
-
339
- #### Returns
340
-
341
- `void`
342
-
343
- #### Inherited from
344
-
345
- [DatabaseQueryError](DatabaseQueryError.md).[captureStackTrace](DatabaseQueryError.md#capturestacktrace)
346
-
347
- #### Defined in
348
-
349
- node_modules/@types/node/globals.d.ts:4