@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
package/docs/classes/ManagedDatabaseConnection.md DELETED
@@ -1,403 +0,0 @@
1
- [@breautek/storm](../README.md) / ManagedDatabaseConnection
2
-
3
- # Class: ManagedDatabaseConnection
4
-
5
- ## Implements
6
-
7
- - [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md)
8
-
9
- ## Table of contents
10
-
11
- ### Constructors
12
-
13
- - [constructor](ManagedDatabaseConnection.md#constructor)
14
-
15
- ### Methods
16
-
17
- - [close](ManagedDatabaseConnection.md#close)
18
- - [commit](ManagedDatabaseConnection.md#commit)
19
- - [getAPI](ManagedDatabaseConnection.md#getapi)
20
- - [getInstantiationStack](ManagedDatabaseConnection.md#getinstantiationstack)
21
- - [getTimeout](ManagedDatabaseConnection.md#gettimeout)
22
- - [hasConnection](ManagedDatabaseConnection.md#hasconnection)
23
- - [isClosed](ManagedDatabaseConnection.md#isclosed)
24
- - [isManaged](ManagedDatabaseConnection.md#ismanaged)
25
- - [isReadOnly](ManagedDatabaseConnection.md#isreadonly)
26
- - [isTransaction](ManagedDatabaseConnection.md#istransaction)
27
- - [isWriteRequired](ManagedDatabaseConnection.md#iswriterequired)
28
- - [query](ManagedDatabaseConnection.md#query)
29
- - [rollback](ManagedDatabaseConnection.md#rollback)
30
- - [setConnection](ManagedDatabaseConnection.md#setconnection)
31
- - [setInstantiationStack](ManagedDatabaseConnection.md#setinstantiationstack)
32
- - [setTimeout](ManagedDatabaseConnection.md#settimeout)
33
- - [startTransaction](ManagedDatabaseConnection.md#starttransaction)
34
- - [stream](ManagedDatabaseConnection.md#stream)
35
-
36
- ## Constructors
37
-
38
- ### constructor
39
-
40
- • **new ManagedDatabaseConnection**(`requiresWrite?`)
41
-
42
- #### Parameters
43
-
44
- | Name | Type | Default value |
45
- | :------ | :------ | :------ |
46
- | `requiresWrite` | `boolean` | `false` |
47
-
48
- #### Defined in
49
-
50
- [src/ManagedDatabaseConnection.ts:38](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L38)
51
-
52
- ## Methods
53
-
54
- ### close
55
-
56
- ▸ **close**(`forceClose?`): `Promise`<`void`\>
57
-
58
- #### Parameters
59
-
60
- | Name | Type |
61
- | :------ | :------ |
62
- | `forceClose?` | `boolean` |
63
-
64
- #### Returns
65
-
66
- `Promise`<`void`\>
67
-
68
- #### Implementation of
69
-
70
- [IDatabaseConnection](../interfaces/IDatabaseConnection.md).[close](../interfaces/IDatabaseConnection.md#close)
71
-
72
- #### Defined in
73
-
74
- [src/ManagedDatabaseConnection.ts:153](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L153)
75
-
76
- ___
77
-
78
- ### commit
79
-
80
- ▸ **commit**(): `Promise`<`void`\>
81
-
82
- #### Returns
83
-
84
- `Promise`<`void`\>
85
-
86
- #### Implementation of
87
-
88
- [IDatabaseConnection](../interfaces/IDatabaseConnection.md).[commit](../interfaces/IDatabaseConnection.md#commit)
89
-
90
- #### Defined in
91
-
92
- [src/ManagedDatabaseConnection.ts:190](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L190)
93
-
94
- ___
95
-
96
- ### getAPI
97
-
98
- ▸ **getAPI**(): `any`
99
-
100
- #### Returns
101
-
102
- `any`
103
-
104
- #### Implementation of
105
-
106
- [IDatabaseConnection](../interfaces/IDatabaseConnection.md).[getAPI](../interfaces/IDatabaseConnection.md#getapi)
107
-
108
- #### Defined in
109
-
110
- [src/ManagedDatabaseConnection.ts:238](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L238)
111
-
112
- ___
113
-
114
- ### getInstantiationStack
115
-
116
- ▸ **getInstantiationStack**(): `string`
117
-
118
- #### Returns
119
-
120
- `string`
121
-
122
- #### Implementation of
123
-
124
- [IDatabaseConnection](../interfaces/IDatabaseConnection.md).[getInstantiationStack](../interfaces/IDatabaseConnection.md#getinstantiationstack)
125
-
126
- #### Defined in
127
-
128
- [src/ManagedDatabaseConnection.ts:105](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L105)
129
-
130
- ___
131
-
132
- ### getTimeout
133
-
134
- ▸ **getTimeout**(): `number`
135
-
136
- #### Returns
137
-
138
- `number`
139
-
140
- #### Implementation of
141
-
142
- [IDatabaseConnection](../interfaces/IDatabaseConnection.md).[getTimeout](../interfaces/IDatabaseConnection.md#gettimeout)
143
-
144
- #### Defined in
145
-
146
- [src/ManagedDatabaseConnection.ts:130](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L130)
147
-
148
- ___
149
-
150
- ### hasConnection
151
-
152
- ▸ **hasConnection**(): `boolean`
153
-
154
- #### Returns
155
-
156
- `boolean`
157
-
158
- #### Defined in
159
-
160
- [src/ManagedDatabaseConnection.ts:92](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L92)
161
-
162
- ___
163
-
164
- ### isClosed
165
-
166
- ▸ **isClosed**(): `boolean`
167
-
168
- #### Returns
169
-
170
- `boolean`
171
-
172
- #### Implementation of
173
-
174
- [IDatabaseConnection](../interfaces/IDatabaseConnection.md).[isClosed](../interfaces/IDatabaseConnection.md#isclosed)
175
-
176
- #### Defined in
177
-
178
- [src/ManagedDatabaseConnection.ts:75](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L75)
179
-
180
- ___
181
-
182
- ### isManaged
183
-
184
- ▸ **isManaged**(): `boolean`
185
-
186
- #### Returns
187
-
188
- `boolean`
189
-
190
- #### Defined in
191
-
192
- [src/ManagedDatabaseConnection.ts:88](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L88)
193
-
194
- ___
195
-
196
- ### isReadOnly
197
-
198
- ▸ **isReadOnly**(): `boolean`
199
-
200
- #### Returns
201
-
202
- `boolean`
203
-
204
- #### Implementation of
205
-
206
- [IDatabaseConnection](../interfaces/IDatabaseConnection.md).[isReadOnly](../interfaces/IDatabaseConnection.md#isreadonly)
207
-
208
- #### Defined in
209
-
210
- [src/ManagedDatabaseConnection.ts:114](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L114)
211
-
212
- ___
213
-
214
- ### isTransaction
215
-
216
- ▸ **isTransaction**(): `boolean`
217
-
218
- #### Returns
219
-
220
- `boolean`
221
-
222
- #### Implementation of
223
-
224
- [IDatabaseConnection](../interfaces/IDatabaseConnection.md).[isTransaction](../interfaces/IDatabaseConnection.md#istransaction)
225
-
226
- #### Defined in
227
-
228
- [src/ManagedDatabaseConnection.ts:181](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L181)
229
-
230
- ___
231
-
232
- ### isWriteRequired
233
-
234
- ▸ **isWriteRequired**(): `boolean`
235
-
236
- #### Returns
237
-
238
- `boolean`
239
-
240
- #### Defined in
241
-
242
- [src/ManagedDatabaseConnection.ts:84](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L84)
243
-
244
- ___
245
-
246
- ### query
247
-
248
- ▸ **query**(`query`, `params?`): `Promise`<`any`\>
249
-
250
- #### Parameters
251
-
252
- | Name | Type |
253
- | :------ | :------ |
254
- | `query` | [`Query`](Query.md)<`any`, `any`, `any`\> |
255
- | `params?` | `any` |
256
-
257
- #### Returns
258
-
259
- `Promise`<`any`\>
260
-
261
- #### Implementation of
262
-
263
- [IDatabaseConnection](../interfaces/IDatabaseConnection.md).[query](../interfaces/IDatabaseConnection.md#query)
264
-
265
- #### Defined in
266
-
267
- [src/ManagedDatabaseConnection.ts:140](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L140)
268
-
269
- ___
270
-
271
- ### rollback
272
-
273
- ▸ **rollback**(): `Promise`<`void`\>
274
-
275
- #### Returns
276
-
277
- `Promise`<`void`\>
278
-
279
- #### Implementation of
280
-
281
- [IDatabaseConnection](../interfaces/IDatabaseConnection.md).[rollback](../interfaces/IDatabaseConnection.md#rollback)
282
-
283
- #### Defined in
284
-
285
- [src/ManagedDatabaseConnection.ts:203](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L203)
286
-
287
- ___
288
-
289
- ### setConnection
290
-
291
- ▸ **setConnection**(`connection`): `void`
292
-
293
- #### Parameters
294
-
295
- | Name | Type |
296
- | :------ | :------ |
297
- | `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
298
-
299
- #### Returns
300
-
301
- `void`
302
-
303
- #### Defined in
304
-
305
- [src/ManagedDatabaseConnection.ts:45](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L45)
306
-
307
- ___
308
-
309
- ### setInstantiationStack
310
-
311
- ▸ **setInstantiationStack**(`stack`): `void`
312
-
313
- #### Parameters
314
-
315
- | Name | Type |
316
- | :------ | :------ |
317
- | `stack` | `string` |
318
-
319
- #### Returns
320
-
321
- `void`
322
-
323
- #### Implementation of
324
-
325
- [IDatabaseConnection](../interfaces/IDatabaseConnection.md).[setInstantiationStack](../interfaces/IDatabaseConnection.md#setinstantiationstack)
326
-
327
- #### Defined in
328
-
329
- [src/ManagedDatabaseConnection.ts:96](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L96)
330
-
331
- ___
332
-
333
- ### setTimeout
334
-
335
- ▸ **setTimeout**(`timeout`): `void`
336
-
337
- #### Parameters
338
-
339
- | Name | Type |
340
- | :------ | :------ |
341
- | `timeout` | `number` |
342
-
343
- #### Returns
344
-
345
- `void`
346
-
347
- #### Implementation of
348
-
349
- [IDatabaseConnection](../interfaces/IDatabaseConnection.md).[setTimeout](../interfaces/IDatabaseConnection.md#settimeout)
350
-
351
- #### Defined in
352
-
353
- [src/ManagedDatabaseConnection.ts:124](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L124)
354
-
355
- ___
356
-
357
- ### startTransaction
358
-
359
- ▸ **startTransaction**(`isolationLevel?`): `Promise`<`void`\>
360
-
361
- #### Parameters
362
-
363
- | Name | Type |
364
- | :------ | :------ |
365
- | `isolationLevel?` | [`IsolationLevel`](../enums/IsolationLevel.md) |
366
-
367
- #### Returns
368
-
369
- `Promise`<`void`\>
370
-
371
- #### Implementation of
372
-
373
- [IDatabaseConnection](../interfaces/IDatabaseConnection.md).[startTransaction](../interfaces/IDatabaseConnection.md#starttransaction)
374
-
375
- #### Defined in
376
-
377
- [src/ManagedDatabaseConnection.ts:168](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L168)
378
-
379
- ___
380
-
381
- ### stream
382
-
383
- ▸ **stream**(`query`, `params?`, `streamOptions?`): `Readable`
384
-
385
- #### Parameters
386
-
387
- | Name | Type |
388
- | :------ | :------ |
389
- | `query` | [`Query`](Query.md)<`any`, `any`, `any`\> |
390
- | `params?` | `any` |
391
- | `streamOptions?` | `any` |
392
-
393
- #### Returns
394
-
395
- `Readable`
396
-
397
- #### Implementation of
398
-
399
- [IDatabaseConnection](../interfaces/IDatabaseConnection.md).[stream](../interfaces/IDatabaseConnection.md#stream)
400
-
401
- #### Defined in
402
-
403
- [src/ManagedDatabaseConnection.ts:149](https://github.com/breautek/storm/blob/3dcafe4/src/ManagedDatabaseConnection.ts#L149)
package/docs/classes/Middleware.md DELETED
@@ -1,72 +0,0 @@
1
- [@breautek/storm](../README.md) / Middleware
2
-
3
- # Class: Middleware
4
-
5
- ## Hierarchy
6
-
7
- - **`Middleware`**
8
-
9
- ↳ [`CORSMiddleware`](CORSMiddleware.md)
10
-
11
- ## Table of contents
12
-
13
- ### Constructors
14
-
15
- - [constructor](Middleware.md#constructor)
16
-
17
- ### Methods
18
-
19
- - [\_execute](Middleware.md#_execute)
20
- - [execute](Middleware.md#execute)
21
-
22
- ## Constructors
23
-
24
- ### constructor
25
-
26
- • **new Middleware**()
27
-
28
- #### Defined in
29
-
30
- [src/Middleware.ts:23](https://github.com/breautek/storm/blob/3dcafe4/src/Middleware.ts#L23)
31
-
32
- ## Methods
33
-
34
- ### \_execute
35
-
36
- ▸ `Protected` `Abstract` **_execute**(`request`, `response`): `Promise`<[`IRequestResponse`](../interfaces/IRequestResponse.md)<`any`, `any`\>\>
37
-
38
- #### Parameters
39
-
40
- | Name | Type |
41
- | :------ | :------ |
42
- | `request` | [`Request`](Request.md)<`any`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> |
43
- | `response` | [`Response`](Response.md)<`any`, `string` \| `Error` \| [`IErrorResponse`](../interfaces/IErrorResponse.md)\> |
44
-
45
- #### Returns
46
-
47
- `Promise`<[`IRequestResponse`](../interfaces/IRequestResponse.md)<`any`, `any`\>\>
48
-
49
- #### Defined in
50
-
51
- [src/Middleware.ts:25](https://github.com/breautek/storm/blob/3dcafe4/src/Middleware.ts#L25)
52
-
53
- ___
54
-
55
- ### execute
56
-
57
- ▸ **execute**(`request`, `response`): `Promise`<[`IRequestResponse`](../interfaces/IRequestResponse.md)<`any`, `any`\>\>
58
-
59
- #### Parameters
60
-
61
- | Name | Type |
62
- | :------ | :------ |
63
- | `request` | [`Request`](Request.md)<`any`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> |
64
- | `response` | [`Response`](Response.md)<`any`, `string` \| `Error` \| [`IErrorResponse`](../interfaces/IErrorResponse.md)\> |
65
-
66
- #### Returns
67
-
68
- `Promise`<[`IRequestResponse`](../interfaces/IRequestResponse.md)<`any`, `any`\>\>
69
-
70
- #### Defined in
71
-
72
- [src/Middleware.ts:27](https://github.com/breautek/storm/blob/3dcafe4/src/Middleware.ts#L27)