@breautek/storm 5.0.1-beta.3 → 5.0.2

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 (183) hide show
  1. package/CHANGELOG.md +18 -2
  2. package/docs/assets/highlight.css +85 -0
  3. package/docs/assets/main.js +58 -0
  4. package/docs/assets/search.js +1 -0
  5. package/docs/assets/style.css +1367 -0
  6. package/docs/classes/Application.html +1235 -0
  7. package/docs/classes/BackendAuthenticationMiddleware.html +191 -0
  8. package/docs/classes/CORSMiddleware.html +257 -0
  9. package/docs/classes/ConfigLoader.html +166 -0
  10. package/docs/classes/Database.html +340 -0
  11. package/docs/classes/DatabaseCastObject.html +203 -0
  12. package/docs/classes/DatabaseConnection.html +550 -0
  13. package/docs/classes/DatabaseQueryError.html +372 -0
  14. package/docs/classes/DeadLockError.html +372 -0
  15. package/docs/classes/DiskSpaceError.html +362 -0
  16. package/docs/classes/DropTemporaryTableQuery.html +285 -0
  17. package/docs/classes/DumpStream.html +161 -0
  18. package/docs/classes/DuplicateEntryError.html +366 -0
  19. package/docs/classes/EntityNotFoundError.html +362 -0
  20. package/docs/classes/ExpiredTokenError.html +362 -0
  21. package/docs/classes/Handler.html +395 -0
  22. package/docs/classes/InternalError.html +362 -0
  23. package/docs/classes/InvalidCredentialsError.html +362 -0
  24. package/docs/classes/InvalidValueError.html +373 -0
  25. package/docs/classes/LineString.html +212 -0
  26. package/docs/classes/LockWaitTimeoutError.html +372 -0
  27. package/docs/classes/ManagedDatabaseConnection.html +410 -0
  28. package/docs/classes/Middleware.html +202 -0
  29. package/docs/classes/MissingConfigError.html +362 -0
  30. package/docs/classes/MissingParameterError.html +362 -0
  31. package/docs/classes/MySQLConnection.html +546 -0
  32. package/docs/classes/MySQLDatabase.html +353 -0
  33. package/docs/classes/NotImplementedError.html +362 -0
  34. package/docs/classes/Point.html +214 -0
  35. package/docs/classes/Polygon.html +212 -0
  36. package/docs/classes/Query.html +312 -0
  37. package/docs/classes/RawError.html +374 -0
  38. package/docs/classes/RawQuery.html +305 -0
  39. package/docs/classes/Request.html +375 -0
  40. package/docs/classes/Response.html +329 -0
  41. package/docs/classes/ResponseData.html +255 -0
  42. package/docs/classes/ServiceProvider.html +385 -0
  43. package/docs/classes/ServiceResponse.html +213 -0
  44. package/docs/classes/SetSessionVariableQuery.html +285 -0
  45. package/docs/classes/StormError.html +377 -0
  46. package/docs/classes/TemporaryTableQuery.html +290 -0
  47. package/docs/classes/Token.html +181 -0
  48. package/docs/classes/TokenManager.html +233 -0
  49. package/docs/classes/Transaction.html +267 -0
  50. package/docs/classes/UnauthorizedAccessError.html +362 -0
  51. package/docs/enums/ErrorCode.html +210 -0
  52. package/docs/enums/ExitCode.html +161 -0
  53. package/docs/enums/HTTPMethod.html +175 -0
  54. package/docs/enums/IsolationLevel.html +175 -0
  55. package/docs/enums/JWTError.html +161 -0
  56. package/docs/enums/StatusCode.html +483 -0
  57. package/docs/functions/formidable-1.html +143 -0
  58. package/docs/functions/getInstance.html +138 -0
  59. package/docs/index.html +224 -0
  60. package/docs/interfaces/IAdditionalErrorDetails.html +140 -0
  61. package/docs/interfaces/IAuthTokenData.html +172 -0
  62. package/docs/interfaces/IConfig.html +225 -0
  63. package/docs/interfaces/IDatabaseConfig.html +198 -0
  64. package/docs/interfaces/IDatabaseConnection.html +332 -0
  65. package/docs/interfaces/IErrorResponse.html +186 -0
  66. package/docs/interfaces/IFormData.html +165 -0
  67. package/docs/interfaces/IHandler.html +171 -0
  68. package/docs/interfaces/IInsertQueryResult.html +172 -0
  69. package/docs/interfaces/IJWTVerifyOptions.html +158 -0
  70. package/docs/interfaces/IParameterMap.html +140 -0
  71. package/docs/interfaces/IQueryable.html +233 -0
  72. package/docs/interfaces/IRequestResponse.html +172 -0
  73. package/docs/interfaces/IServiceHeaders.html +140 -0
  74. package/docs/interfaces/ISetSessionVariableQueryInput.html +165 -0
  75. package/docs/interfaces/ITemporaryTableQueryInput.html +165 -0
  76. package/docs/interfaces/IUpdateQueryResult.html +165 -0
  77. package/docs/interfaces/formidable.EmitData.html +180 -0
  78. package/docs/interfaces/formidable.EventData.html +201 -0
  79. package/docs/interfaces/formidable.Fields.html +141 -0
  80. package/docs/interfaces/formidable.File.html +239 -0
  81. package/docs/interfaces/formidable.FileJSON.html +238 -0
  82. package/docs/interfaces/formidable.Files.html +141 -0
  83. package/docs/interfaces/formidable.Options.html +308 -0
  84. package/docs/interfaces/formidable.Part.html +691 -0
  85. package/docs/modules/formidable.html +159 -0
  86. package/docs/types/IDeleteQueryResult.html +134 -0
  87. package/docs/types/IHandlerError.html +139 -0
  88. package/docs/types/IHandlerResponse.html +145 -0
  89. package/docs/types/TCoordinate.html +134 -0
  90. package/docs/types/formidable.BufferEncoding.html +135 -0
  91. package/docs/types/formidable.DefaultOptions.html +135 -0
  92. package/docs/types/formidable.EnabledPlugins.html +135 -0
  93. package/docs/types/formidable.EventNames.html +135 -0
  94. package/docs/types/formidable.MappedParsers.html +135 -0
  95. package/docs/types/formidable.Plugin.html +135 -0
  96. package/docs/types/formidable.PluginFunction.html +150 -0
  97. package/docs/types/formidable.Plugins.html +135 -0
  98. package/lib/StatusCode.d.ts +1 -1
  99. package/lib/StatusCode.js +1 -1
  100. package/lib/Transaction.d.ts +4 -0
  101. package/lib/Transaction.js +4 -0
  102. package/lib/Transaction.js.map +1 -1
  103. package/package.json +14 -14
  104. package/src/StatusCode.ts +1 -1
  105. package/src/Transaction.ts +4 -0
  106. package/docs/README.md +0 -188
  107. package/docs/classes/Application.md +0 -1648
  108. package/docs/classes/BackendAuthenticationMiddleware.md +0 -49
  109. package/docs/classes/CORSMiddleware.md +0 -143
  110. package/docs/classes/ConfigLoader.md +0 -29
  111. package/docs/classes/Database.md +0 -259
  112. package/docs/classes/DatabaseCastObject.md +0 -79
  113. package/docs/classes/DatabaseConnection.md +0 -556
  114. package/docs/classes/DatabaseQueryError.md +0 -351
  115. package/docs/classes/DeadLockError.md +0 -349
  116. package/docs/classes/DiskSpaceError.md +0 -341
  117. package/docs/classes/DropTemporaryTableQuery.md +0 -207
  118. package/docs/classes/DumpStream.md +0 -23
  119. package/docs/classes/DuplicateEntryError.md +0 -343
  120. package/docs/classes/EntityNotFoundError.md +0 -341
  121. package/docs/classes/ExpiredTokenError.md +0 -341
  122. package/docs/classes/Handler.md +0 -302
  123. package/docs/classes/InternalError.md +0 -341
  124. package/docs/classes/InvalidCredentialsError.md +0 -341
  125. package/docs/classes/InvalidValueError.md +0 -349
  126. package/docs/classes/LineString.md +0 -101
  127. package/docs/classes/LockWaitTimeoutError.md +0 -349
  128. package/docs/classes/ManagedDatabaseConnection.md +0 -403
  129. package/docs/classes/Middleware.md +0 -72
  130. package/docs/classes/MissingConfigError.md +0 -341
  131. package/docs/classes/MissingParameterError.md +0 -341
  132. package/docs/classes/MySQLConnection.md +0 -569
  133. package/docs/classes/MySQLDatabase.md +0 -314
  134. package/docs/classes/NotImplementedError.md +0 -341
  135. package/docs/classes/Point.md +0 -102
  136. package/docs/classes/Polygon.md +0 -101
  137. package/docs/classes/Query.md +0 -227
  138. package/docs/classes/RawError.md +0 -351
  139. package/docs/classes/RawQuery.md +0 -224
  140. package/docs/classes/Request.md +0 -321
  141. package/docs/classes/Response.md +0 -242
  142. package/docs/classes/ResponseData.md +0 -144
  143. package/docs/classes/ServiceProvider.md +0 -296
  144. package/docs/classes/ServiceResponse.md +0 -89
  145. package/docs/classes/SetSessionVariableQuery.md +0 -207
  146. package/docs/classes/StormError.md +0 -343
  147. package/docs/classes/TemporaryTableQuery.md +0 -213
  148. package/docs/classes/Token.md +0 -43
  149. package/docs/classes/TokenManager.md +0 -105
  150. package/docs/classes/Transaction.md +0 -161
  151. package/docs/classes/UnauthorizedAccessError.md +0 -341
  152. package/docs/enums/ErrorCode.md +0 -107
  153. package/docs/enums/ExitCode.md +0 -30
  154. package/docs/enums/HTTPMethod.md +0 -52
  155. package/docs/enums/IsolationLevel.md +0 -52
  156. package/docs/enums/JWTError.md +0 -30
  157. package/docs/enums/StatusCode.md +0 -536
  158. package/docs/interfaces/IAdditionalErrorDetails.md +0 -7
  159. package/docs/interfaces/IAuthTokenData.md +0 -41
  160. package/docs/interfaces/IConfig.md +0 -112
  161. package/docs/interfaces/IDatabaseConfig.md +0 -80
  162. package/docs/interfaces/IDatabaseConnection.md +0 -262
  163. package/docs/interfaces/IErrorResponse.md +0 -63
  164. package/docs/interfaces/IFormData.md +0 -30
  165. package/docs/interfaces/IHandler.md +0 -31
  166. package/docs/interfaces/IInsertQueryResult.md +0 -41
  167. package/docs/interfaces/IJWTVerifyOptions.md +0 -19
  168. package/docs/interfaces/IParameterMap.md +0 -7
  169. package/docs/interfaces/IQueryable.md +0 -119
  170. package/docs/interfaces/IRequestResponse.md +0 -37
  171. package/docs/interfaces/IServiceHeaders.md +0 -7
  172. package/docs/interfaces/ISetSessionVariableQueryInput.md +0 -30
  173. package/docs/interfaces/ITemporaryTableQueryInput.md +0 -30
  174. package/docs/interfaces/IUpdateQueryResult.md +0 -30
  175. package/docs/interfaces/formidable.EmitData.md +0 -54
  176. package/docs/interfaces/formidable.EventData.md +0 -87
  177. package/docs/interfaces/formidable.Fields.md +0 -9
  178. package/docs/interfaces/formidable.File.md +0 -131
  179. package/docs/interfaces/formidable.FileJSON.md +0 -151
  180. package/docs/interfaces/formidable.Files.md +0 -9
  181. package/docs/interfaces/formidable.Options.md +0 -225
  182. package/docs/interfaces/formidable.Part.md +0 -793
  183. package/docs/modules/formidable.md +0 -122
package/docs/classes/LockWaitTimeoutError.md DELETED
@@ -1,349 +0,0 @@
1
- [@breautek/storm](../README.md) / LockWaitTimeoutError
2
-
3
- # Class: LockWaitTimeoutError
4
-
5
- DeadLockError is a DatabaseQueryError but is subclasses for typing purposes.
6
-
7
- ## Hierarchy
8
-
9
- - [`DatabaseQueryError`](DatabaseQueryError.md)
10
-
11
- ↳ **`LockWaitTimeoutError`**
12
-
13
- ## Table of contents
14
-
15
- ### Constructors
16
-
17
- - [constructor](LockWaitTimeoutError.md#constructor)
18
-
19
- ### Properties
20
-
21
- - [message](LockWaitTimeoutError.md#message)
22
- - [name](LockWaitTimeoutError.md#name)
23
- - [stack](LockWaitTimeoutError.md#stack)
24
- - [prepareStackTrace](LockWaitTimeoutError.md#preparestacktrace)
25
- - [stackTraceLimit](LockWaitTimeoutError.md#stacktracelimit)
26
-
27
- ### Methods
28
-
29
- - [getCode](LockWaitTimeoutError.md#getcode)
30
- - [getErrorResponse](LockWaitTimeoutError.md#geterrorresponse)
31
- - [getExitCode](LockWaitTimeoutError.md#getexitcode)
32
- - [getHTTPCode](LockWaitTimeoutError.md#gethttpcode)
33
- - [getLocaleCode](LockWaitTimeoutError.md#getlocalecode)
34
- - [getLocaleParameters](LockWaitTimeoutError.md#getlocaleparameters)
35
- - [getMessage](LockWaitTimeoutError.md#getmessage)
36
- - [getPrivateDetails](LockWaitTimeoutError.md#getprivatedetails)
37
- - [getPublicDetails](LockWaitTimeoutError.md#getpublicdetails)
38
- - [captureStackTrace](LockWaitTimeoutError.md#capturestacktrace)
39
-
40
- ## Constructors
41
-
42
- ### constructor
43
-
44
- • **new LockWaitTimeoutError**(`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/d45307d/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/d45307d/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/d45307d/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/d45307d/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/d45307d/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/d45307d/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/d45307d/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/d45307d/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/d45307d/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/d45307d/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