@breautek/storm 4.0.0 → 4.2.0

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 (217) hide show
  1. package/CHANGELOG.md +18 -1
  2. package/bt-config-sample.jsonc +1 -1
  3. package/docs/README.md +8 -6
  4. package/docs/classes/Application.md +30 -30
  5. package/docs/classes/BackendAuthenticationMiddleware.md +2 -2
  6. package/docs/classes/CORSMiddleware.md +6 -6
  7. package/docs/classes/ConfigLoader.md +1 -1
  8. package/docs/classes/Database.md +12 -12
  9. package/docs/classes/DatabaseConnection.md +19 -19
  10. package/docs/classes/DatabaseQueryError.md +11 -11
  11. package/docs/classes/DiskSpaceError.md +11 -11
  12. package/docs/classes/DropTemporaryTableQuery.md +16 -10
  13. package/docs/classes/DumpStream.md +1 -1
  14. package/docs/classes/DuplicateEntryError.md +11 -11
  15. package/docs/classes/EntityNotFoundError.md +11 -11
  16. package/docs/classes/ExpiredTokenError.md +11 -11
  17. package/docs/classes/Handler.md +22 -22
  18. package/docs/classes/InternalError.md +11 -11
  19. package/docs/classes/InvalidCredentialsError.md +11 -11
  20. package/docs/classes/InvalidValueError.md +11 -11
  21. package/docs/classes/ManagedDatabaseConnection.md +19 -19
  22. package/docs/classes/Middleware.md +3 -3
  23. package/docs/classes/MissingConfigError.md +11 -11
  24. package/docs/classes/MissingParameterError.md +11 -11
  25. package/docs/classes/MySQLConnection.md +20 -20
  26. package/docs/classes/MySQLDatabase.md +14 -14
  27. package/docs/classes/NotImplementedError.md +301 -0
  28. package/docs/classes/Query.md +16 -10
  29. package/docs/classes/RawError.md +313 -0
  30. package/docs/classes/RawQuery.md +25 -17
  31. package/docs/classes/Request.md +18 -18
  32. package/docs/classes/Response.md +12 -12
  33. package/docs/classes/ResponseData.md +7 -7
  34. package/docs/classes/ServiceProvider.md +16 -16
  35. package/docs/classes/ServiceResponse.md +4 -4
  36. package/docs/classes/SetSessionVariableQuery.md +16 -10
  37. package/docs/classes/StormError.md +15 -11
  38. package/docs/classes/TemporaryTableQuery.md +16 -10
  39. package/docs/classes/Token.md +2 -2
  40. package/docs/classes/TokenManager.md +4 -4
  41. package/docs/classes/UnauthorizedAccessError.md +11 -11
  42. package/docs/enums/ErrorCode.md +20 -20
  43. package/docs/enums/ExitCode.md +6 -6
  44. package/docs/enums/HTTPMethod.md +10 -10
  45. package/docs/enums/JWTError.md +6 -6
  46. package/docs/enums/StatusCode.md +98 -98
  47. package/docs/interfaces/IConfig.md +8 -8
  48. package/docs/interfaces/IDatabaseConfig.md +6 -6
  49. package/docs/interfaces/IDatabaseConnection.md +15 -15
  50. package/docs/interfaces/IErrorResponse.md +4 -4
  51. package/docs/interfaces/IFormData.md +2 -2
  52. package/docs/interfaces/IHandler.md +1 -1
  53. package/docs/interfaces/IInsertQueryResult.md +3 -3
  54. package/docs/interfaces/IJWTVerifyOptions.md +1 -1
  55. package/docs/interfaces/IRequestResponse.md +2 -2
  56. package/docs/interfaces/ISetSessionVariableQueryInput.md +2 -2
  57. package/docs/interfaces/ITemporaryTableQueryInput.md +2 -2
  58. package/docs/interfaces/IUpdateQueryResult.md +2 -2
  59. package/docs/interfaces/formidable.EmitData.md +1 -1
  60. package/docs/modules/formidable.md +2 -2
  61. package/lib/Application.d.ts +58 -0
  62. package/lib/Application.js +73 -0
  63. package/lib/Application.js.map +1 -1
  64. package/lib/ApplicationEvent.js +15 -0
  65. package/lib/ApplicationEvent.js.map +1 -1
  66. package/lib/BackendAuthenticationMiddleware.d.ts +12 -0
  67. package/lib/BackendAuthenticationMiddleware.js +28 -0
  68. package/lib/BackendAuthenticationMiddleware.js.map +1 -1
  69. package/lib/CORSMiddleware.d.ts +14 -0
  70. package/lib/CORSMiddleware.js +29 -0
  71. package/lib/CORSMiddleware.js.map +1 -1
  72. package/lib/ConfigLoader.js +16 -0
  73. package/lib/ConfigLoader.js.map +1 -1
  74. package/lib/Database.js +15 -0
  75. package/lib/Database.js.map +1 -1
  76. package/lib/DatabaseConnection.d.ts +115 -0
  77. package/lib/DatabaseConnection.js +71 -0
  78. package/lib/DatabaseConnection.js.map +1 -1
  79. package/lib/DatabaseQueryError.js +16 -0
  80. package/lib/DatabaseQueryError.js.map +1 -1
  81. package/lib/DiskSpaceError.js +15 -0
  82. package/lib/DiskSpaceError.js.map +1 -1
  83. package/lib/DropTemporaryTableQuery.js +15 -0
  84. package/lib/DropTemporaryTableQuery.js.map +1 -1
  85. package/lib/DumpStream.js +16 -0
  86. package/lib/DumpStream.js.map +1 -1
  87. package/lib/DuplicateEntryError.js +15 -0
  88. package/lib/DuplicateEntryError.js.map +1 -1
  89. package/lib/EntityNotFoundError.js +15 -0
  90. package/lib/EntityNotFoundError.js.map +1 -1
  91. package/lib/ErrorCode.js +15 -0
  92. package/lib/ErrorCode.js.map +1 -1
  93. package/lib/ExitCode.js +15 -0
  94. package/lib/ExitCode.js.map +1 -1
  95. package/lib/ExpiredTokenError.js +16 -0
  96. package/lib/ExpiredTokenError.js.map +1 -1
  97. package/lib/HTTPMethod.js +15 -0
  98. package/lib/HTTPMethod.js.map +1 -1
  99. package/lib/Handler.d.ts +22 -4
  100. package/lib/Handler.js +22 -6
  101. package/lib/Handler.js.map +1 -1
  102. package/lib/IAuthTokenData.js +15 -0
  103. package/lib/IAuthTokenData.js.map +1 -1
  104. package/lib/IConfig.js +15 -0
  105. package/lib/IConfig.js.map +1 -1
  106. package/lib/IDatabaseConfig.js +15 -0
  107. package/lib/IDatabaseConfig.js.map +1 -1
  108. package/lib/IDatabaseConnection.js +15 -0
  109. package/lib/IDatabaseConnection.js.map +1 -1
  110. package/lib/IDeleteQueryResult.js +15 -0
  111. package/lib/IDeleteQueryResult.js.map +1 -1
  112. package/lib/IFormData.js +15 -0
  113. package/lib/IFormData.js.map +1 -1
  114. package/lib/IHandler.js +15 -0
  115. package/lib/IHandler.js.map +1 -1
  116. package/lib/IInsertQueryResult.js +15 -0
  117. package/lib/IInsertQueryResult.js.map +1 -1
  118. package/lib/IJWTVerifyOptions.js +15 -0
  119. package/lib/IJWTVerifyOptions.js.map +1 -1
  120. package/lib/IRequestResponse.js +15 -0
  121. package/lib/IRequestResponse.js.map +1 -1
  122. package/lib/IServiceHeaders.js +15 -0
  123. package/lib/IServiceHeaders.js.map +1 -1
  124. package/lib/IUpdateQueryResult.js +15 -0
  125. package/lib/IUpdateQueryResult.js.map +1 -1
  126. package/lib/InternalError.js +16 -0
  127. package/lib/InternalError.js.map +1 -1
  128. package/lib/InvalidConfigError.js +15 -0
  129. package/lib/InvalidConfigError.js.map +1 -1
  130. package/lib/InvalidCredentialsError.js +16 -0
  131. package/lib/InvalidCredentialsError.js.map +1 -1
  132. package/lib/InvalidValueError.js +16 -0
  133. package/lib/InvalidValueError.js.map +1 -1
  134. package/lib/JWTError.js +15 -0
  135. package/lib/JWTError.js.map +1 -1
  136. package/lib/JWTVerifyOptionsParser.js +16 -0
  137. package/lib/JWTVerifyOptionsParser.js.map +1 -1
  138. package/lib/ManagedDatabaseConnection.d.ts +5 -0
  139. package/lib/ManagedDatabaseConnection.js +26 -0
  140. package/lib/ManagedDatabaseConnection.js.map +1 -1
  141. package/lib/Middleware.js +16 -0
  142. package/lib/Middleware.js.map +1 -1
  143. package/lib/MissingConfigError.js +15 -0
  144. package/lib/MissingConfigError.js.map +1 -1
  145. package/lib/MissingParameterError.js +15 -0
  146. package/lib/MissingParameterError.js.map +1 -1
  147. package/lib/MySQLConnection.js +24 -1
  148. package/lib/MySQLConnection.js.map +1 -1
  149. package/lib/MySQLDatabase.js +18 -0
  150. package/lib/MySQLDatabase.js.map +1 -1
  151. package/lib/NotImplementedError.d.ts +14 -0
  152. package/lib/NotImplementedError.js +40 -0
  153. package/lib/NotImplementedError.js.map +1 -0
  154. package/lib/Query.d.ts +22 -2
  155. package/lib/Query.js +37 -0
  156. package/lib/Query.js.map +1 -1
  157. package/lib/RawError.d.ts +14 -0
  158. package/lib/RawError.js +40 -0
  159. package/lib/RawError.js.map +1 -0
  160. package/lib/RawQuery.d.ts +1 -1
  161. package/lib/RawQuery.js +15 -0
  162. package/lib/RawQuery.js.map +1 -1
  163. package/lib/Request.d.ts +1 -0
  164. package/lib/Request.js +15 -0
  165. package/lib/Request.js.map +1 -1
  166. package/lib/Response.d.ts +1 -0
  167. package/lib/Response.js +17 -0
  168. package/lib/Response.js.map +1 -1
  169. package/lib/ResponseData.js +15 -0
  170. package/lib/ResponseData.js.map +1 -1
  171. package/lib/ServiceProvider.d.ts +1 -2
  172. package/lib/ServiceProvider.js +20 -0
  173. package/lib/ServiceProvider.js.map +1 -1
  174. package/lib/ServiceResponse.d.ts +1 -0
  175. package/lib/ServiceResponse.js +15 -0
  176. package/lib/ServiceResponse.js.map +1 -1
  177. package/lib/SetSessionVariableQuery.d.ts +1 -2
  178. package/lib/SetSessionVariableQuery.js +1 -0
  179. package/lib/SetSessionVariableQuery.js.map +1 -1
  180. package/lib/StatusCode.js +15 -0
  181. package/lib/StatusCode.js.map +1 -1
  182. package/lib/StormError.d.ts +7 -0
  183. package/lib/StormError.js +22 -0
  184. package/lib/StormError.js.map +1 -1
  185. package/lib/TemporaryTableQuery.d.ts +1 -2
  186. package/lib/TemporaryTableQuery.js +15 -0
  187. package/lib/TemporaryTableQuery.js.map +1 -1
  188. package/lib/Token.js +15 -0
  189. package/lib/Token.js.map +1 -1
  190. package/lib/TokenManager.js +17 -0
  191. package/lib/TokenManager.js.map +1 -1
  192. package/lib/UnauthorizedAccessError.js +15 -0
  193. package/lib/UnauthorizedAccessError.js.map +1 -1
  194. package/lib/api.d.ts +2 -0
  195. package/lib/api.js +28 -1
  196. package/lib/api.js.map +1 -1
  197. package/lib/instance.js +15 -0
  198. package/lib/instance.js.map +1 -1
  199. package/lib/private/CommitQuery.js +15 -0
  200. package/lib/private/CommitQuery.js.map +1 -1
  201. package/lib/private/RollbackQuery.js +15 -0
  202. package/lib/private/RollbackQuery.js.map +1 -1
  203. package/lib/private/StartTransactionQuery.js +15 -0
  204. package/lib/private/StartTransactionQuery.js.map +1 -1
  205. package/package.json +15 -16
  206. package/src/Database.ts +1 -2
  207. package/src/DatabaseConnection.ts +2 -3
  208. package/src/Handler.ts +10 -9
  209. package/src/NotImplementedError.ts +45 -0
  210. package/src/Query.ts +9 -2
  211. package/src/RawError.ts +39 -0
  212. package/src/RawQuery.ts +1 -1
  213. package/src/ServiceProvider.ts +1 -2
  214. package/src/SetSessionVariableQuery.ts +1 -2
  215. package/src/TemporaryTableQuery.ts +2 -3
  216. package/src/api.ts +2 -0
  217. package/tsconfig.json +0 -1
package/docs/classes/DatabaseConnection.md CHANGED
@@ -73,7 +73,7 @@ Do not call `new Database` directly. Use `Database.getConnection` to create a `D
73
73
 
74
74
  #### Defined in
75
75
 
76
- [src/DatabaseConnection.ts:44](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L44)
76
+ [src/DatabaseConnection.ts:43](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L43)
77
77
 
78
78
  ## Methods
79
79
 
@@ -100,7 +100,7 @@ Promise<void>
100
100
 
101
101
  #### Defined in
102
102
 
103
- [src/DatabaseConnection.ts:239](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L239)
103
+ [src/DatabaseConnection.ts:238](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L238)
104
104
 
105
105
  ___
106
106
 
@@ -133,7 +133,7 @@ Promise
133
133
 
134
134
  #### Defined in
135
135
 
136
- [src/DatabaseConnection.ts:250](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L250)
136
+ [src/DatabaseConnection.ts:249](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L249)
137
137
 
138
138
  ___
139
139
 
@@ -160,7 +160,7 @@ but returns a `Readable` stream instead.
160
160
 
161
161
  #### Defined in
162
162
 
163
- [src/DatabaseConnection.ts:262](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L262)
163
+ [src/DatabaseConnection.ts:261](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L261)
164
164
 
165
165
  ___
166
166
 
@@ -192,7 +192,7 @@ Promise<void>
192
192
 
193
193
  #### Defined in
194
194
 
195
- [src/DatabaseConnection.ts:169](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L169)
195
+ [src/DatabaseConnection.ts:168](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L168)
196
196
 
197
197
  ___
198
198
 
@@ -218,7 +218,7 @@ Promise<void>
218
218
 
219
219
  #### Defined in
220
220
 
221
- [src/DatabaseConnection.ts:220](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L220)
221
+ [src/DatabaseConnection.ts:219](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L219)
222
222
 
223
223
  ___
224
224
 
@@ -246,7 +246,7 @@ Promise<void>
246
246
 
247
247
  #### Defined in
248
248
 
249
- [src/DatabaseConnection.ts:211](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L211)
249
+ [src/DatabaseConnection.ts:210](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L210)
250
250
 
251
251
  ___
252
252
 
@@ -268,7 +268,7 @@ any
268
268
 
269
269
  #### Defined in
270
270
 
271
- [src/DatabaseConnection.ts:91](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L91)
271
+ [src/DatabaseConnection.ts:90](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L90)
272
272
 
273
273
  ___
274
274
 
@@ -291,7 +291,7 @@ string - A stacktrace
291
291
 
292
292
  #### Defined in
293
293
 
294
- [src/DatabaseConnection.ts:73](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L73)
294
+ [src/DatabaseConnection.ts:72](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L72)
295
295
 
296
296
  ___
297
297
 
@@ -313,7 +313,7 @@ number in milliseconds
313
313
 
314
314
  #### Defined in
315
315
 
316
- [src/DatabaseConnection.ts:121](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L121)
316
+ [src/DatabaseConnection.ts:120](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L120)
317
317
 
318
318
  ___
319
319
 
@@ -333,7 +333,7 @@ Returns true if the connection has been closed.
333
333
 
334
334
  #### Defined in
335
335
 
336
- [src/DatabaseConnection.ts:182](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L182)
336
+ [src/DatabaseConnection.ts:181](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L181)
337
337
 
338
338
  ___
339
339
 
@@ -356,7 +356,7 @@ boolean
356
356
 
357
357
  #### Defined in
358
358
 
359
- [src/DatabaseConnection.ts:100](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L100)
359
+ [src/DatabaseConnection.ts:99](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L99)
360
360
 
361
361
  ___
362
362
 
@@ -380,7 +380,7 @@ boolean
380
380
 
381
381
  #### Defined in
382
382
 
383
- [src/DatabaseConnection.ts:201](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L201)
383
+ [src/DatabaseConnection.ts:200](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L200)
384
384
 
385
385
  ___
386
386
 
@@ -416,7 +416,7 @@ Promise<TQueryResult>
416
416
 
417
417
  #### Defined in
418
418
 
419
- [src/DatabaseConnection.ts:132](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L132)
419
+ [src/DatabaseConnection.ts:131](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L131)
420
420
 
421
421
  ___
422
422
 
@@ -442,7 +442,7 @@ Promise<void>
442
442
 
443
443
  #### Defined in
444
444
 
445
- [src/DatabaseConnection.ts:229](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L229)
445
+ [src/DatabaseConnection.ts:228](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L228)
446
446
 
447
447
  ___
448
448
 
@@ -466,7 +466,7 @@ ___
466
466
 
467
467
  #### Defined in
468
468
 
469
- [src/DatabaseConnection.ts:64](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L64)
469
+ [src/DatabaseConnection.ts:63](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L63)
470
470
 
471
471
  ___
472
472
 
@@ -492,7 +492,7 @@ Sets the timeout of this connectino
492
492
 
493
493
  #### Defined in
494
494
 
495
- [src/DatabaseConnection.ts:109](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L109)
495
+ [src/DatabaseConnection.ts:108](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L108)
496
496
 
497
497
  ___
498
498
 
@@ -518,7 +518,7 @@ Promise<void>
518
518
 
519
519
  #### Defined in
520
520
 
521
- [src/DatabaseConnection.ts:193](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L193)
521
+ [src/DatabaseConnection.ts:192](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L192)
522
522
 
523
523
  ___
524
524
 
@@ -545,4 +545,4 @@ Readable
545
545
 
546
546
  #### Defined in
547
547
 
548
- [src/DatabaseConnection.ts:152](https://github.com/breautek/storm/blob/186ee78/src/DatabaseConnection.ts#L152)
548
+ [src/DatabaseConnection.ts:151](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L151)
package/docs/classes/DatabaseQueryError.md CHANGED
@@ -52,7 +52,7 @@
52
52
 
53
53
  #### Defined in
54
54
 
55
- [src/DatabaseQueryError.ts:25](https://github.com/breautek/storm/blob/186ee78/src/DatabaseQueryError.ts#L25)
55
+ [src/DatabaseQueryError.ts:25](https://github.com/breautek/storm/blob/f198938/src/DatabaseQueryError.ts#L25)
56
56
 
57
57
  ## Properties
58
58
 
@@ -66,7 +66,7 @@
66
66
 
67
67
  #### Defined in
68
68
 
69
- node_modules/typescript/lib/lib.es5.d.ts:1023
69
+ node_modules/typescript/lib/lib.es5.d.ts:1029
70
70
 
71
71
  ___
72
72
 
@@ -80,7 +80,7 @@ ___
80
80
 
81
81
  #### Defined in
82
82
 
83
- node_modules/typescript/lib/lib.es5.d.ts:1022
83
+ node_modules/typescript/lib/lib.es5.d.ts:1028
84
84
 
85
85
  ___
86
86
 
@@ -94,7 +94,7 @@ ___
94
94
 
95
95
  #### Defined in
96
96
 
97
- node_modules/typescript/lib/lib.es5.d.ts:1024
97
+ node_modules/typescript/lib/lib.es5.d.ts:1030
98
98
 
99
99
  ___
100
100
 
@@ -159,7 +159,7 @@ node_modules/@types/node/globals.d.ts:13
159
159
 
160
160
  #### Defined in
161
161
 
162
- [src/DatabaseQueryError.ts:36](https://github.com/breautek/storm/blob/186ee78/src/DatabaseQueryError.ts#L36)
162
+ [src/DatabaseQueryError.ts:36](https://github.com/breautek/storm/blob/f198938/src/DatabaseQueryError.ts#L36)
163
163
 
164
164
  ___
165
165
 
@@ -177,7 +177,7 @@ ___
177
177
 
178
178
  #### Defined in
179
179
 
180
- [src/StormError.ts:70](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L70)
180
+ [src/StormError.ts:70](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L70)
181
181
 
182
182
  ___
183
183
 
@@ -195,7 +195,7 @@ ___
195
195
 
196
196
  #### Defined in
197
197
 
198
- [src/StormError.ts:79](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L79)
198
+ [src/StormError.ts:79](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L79)
199
199
 
200
200
  ___
201
201
 
@@ -213,7 +213,7 @@ ___
213
213
 
214
214
  #### Defined in
215
215
 
216
- [src/DatabaseQueryError.ts:40](https://github.com/breautek/storm/blob/186ee78/src/DatabaseQueryError.ts#L40)
216
+ [src/DatabaseQueryError.ts:40](https://github.com/breautek/storm/blob/f198938/src/DatabaseQueryError.ts#L40)
217
217
 
218
218
  ___
219
219
 
@@ -231,7 +231,7 @@ ___
231
231
 
232
232
  #### Defined in
233
233
 
234
- [src/DatabaseQueryError.ts:32](https://github.com/breautek/storm/blob/186ee78/src/DatabaseQueryError.ts#L32)
234
+ [src/DatabaseQueryError.ts:32](https://github.com/breautek/storm/blob/f198938/src/DatabaseQueryError.ts#L32)
235
235
 
236
236
  ___
237
237
 
@@ -257,7 +257,7 @@ They are kept secret from the client.
257
257
 
258
258
  #### Defined in
259
259
 
260
- [src/StormError.ts:62](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L62)
260
+ [src/StormError.ts:62](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L62)
261
261
 
262
262
  ___
263
263
 
@@ -277,7 +277,7 @@ Sends details to the client.
277
277
 
278
278
  #### Defined in
279
279
 
280
- [src/StormError.ts:54](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L54)
280
+ [src/StormError.ts:54](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L54)
281
281
 
282
282
  ___
283
283
 
package/docs/classes/DiskSpaceError.md CHANGED
@@ -51,7 +51,7 @@
51
51
 
52
52
  #### Defined in
53
53
 
54
- [src/DiskSpaceError.ts:22](https://github.com/breautek/storm/blob/186ee78/src/DiskSpaceError.ts#L22)
54
+ [src/DiskSpaceError.ts:22](https://github.com/breautek/storm/blob/f198938/src/DiskSpaceError.ts#L22)
55
55
 
56
56
  ## Properties
57
57
 
@@ -65,7 +65,7 @@
65
65
 
66
66
  #### Defined in
67
67
 
68
- node_modules/typescript/lib/lib.es5.d.ts:1023
68
+ node_modules/typescript/lib/lib.es5.d.ts:1029
69
69
 
70
70
  ___
71
71
 
@@ -79,7 +79,7 @@ ___
79
79
 
80
80
  #### Defined in
81
81
 
82
- node_modules/typescript/lib/lib.es5.d.ts:1022
82
+ node_modules/typescript/lib/lib.es5.d.ts:1028
83
83
 
84
84
  ___
85
85
 
@@ -93,7 +93,7 @@ ___
93
93
 
94
94
  #### Defined in
95
95
 
96
- node_modules/typescript/lib/lib.es5.d.ts:1024
96
+ node_modules/typescript/lib/lib.es5.d.ts:1030
97
97
 
98
98
  ___
99
99
 
@@ -158,7 +158,7 @@ node_modules/@types/node/globals.d.ts:13
158
158
 
159
159
  #### Defined in
160
160
 
161
- [src/DiskSpaceError.ts:32](https://github.com/breautek/storm/blob/186ee78/src/DiskSpaceError.ts#L32)
161
+ [src/DiskSpaceError.ts:32](https://github.com/breautek/storm/blob/f198938/src/DiskSpaceError.ts#L32)
162
162
 
163
163
  ___
164
164
 
@@ -176,7 +176,7 @@ ___
176
176
 
177
177
  #### Defined in
178
178
 
179
- [src/StormError.ts:70](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L70)
179
+ [src/StormError.ts:70](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L70)
180
180
 
181
181
  ___
182
182
 
@@ -194,7 +194,7 @@ ___
194
194
 
195
195
  #### Defined in
196
196
 
197
- [src/StormError.ts:79](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L79)
197
+ [src/StormError.ts:79](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L79)
198
198
 
199
199
  ___
200
200
 
@@ -212,7 +212,7 @@ ___
212
212
 
213
213
  #### Defined in
214
214
 
215
- [src/DiskSpaceError.ts:36](https://github.com/breautek/storm/blob/186ee78/src/DiskSpaceError.ts#L36)
215
+ [src/DiskSpaceError.ts:36](https://github.com/breautek/storm/blob/f198938/src/DiskSpaceError.ts#L36)
216
216
 
217
217
  ___
218
218
 
@@ -230,7 +230,7 @@ ___
230
230
 
231
231
  #### Defined in
232
232
 
233
- [src/DiskSpaceError.ts:28](https://github.com/breautek/storm/blob/186ee78/src/DiskSpaceError.ts#L28)
233
+ [src/DiskSpaceError.ts:28](https://github.com/breautek/storm/blob/f198938/src/DiskSpaceError.ts#L28)
234
234
 
235
235
  ___
236
236
 
@@ -251,7 +251,7 @@ They are kept secret from the client.
251
251
 
252
252
  #### Defined in
253
253
 
254
- [src/StormError.ts:62](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L62)
254
+ [src/StormError.ts:62](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L62)
255
255
 
256
256
  ___
257
257
 
@@ -271,7 +271,7 @@ Sends details to the client.
271
271
 
272
272
  #### Defined in
273
273
 
274
- [src/StormError.ts:54](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L54)
274
+ [src/StormError.ts:54](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L54)
275
275
 
276
276
  ___
277
277
 
package/docs/classes/DropTemporaryTableQuery.md CHANGED
@@ -42,7 +42,7 @@
42
42
 
43
43
  #### Defined in
44
44
 
45
- [src/Query.ts:23](https://github.com/breautek/storm/blob/186ee78/src/Query.ts#L23)
45
+ [src/Query.ts:22](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L22)
46
46
 
47
47
  ## Methods
48
48
 
@@ -60,7 +60,7 @@
60
60
 
61
61
  #### Defined in
62
62
 
63
- [src/DropTemporaryTableQuery.ts:29](https://github.com/breautek/storm/blob/186ee78/src/DropTemporaryTableQuery.ts#L29)
63
+ [src/DropTemporaryTableQuery.ts:29](https://github.com/breautek/storm/blob/f198938/src/DropTemporaryTableQuery.ts#L29)
64
64
 
65
65
  ___
66
66
 
@@ -84,7 +84,7 @@ ___
84
84
 
85
85
  #### Defined in
86
86
 
87
- [src/Query.ts:63](https://github.com/breautek/storm/blob/186ee78/src/Query.ts#L63)
87
+ [src/Query.ts:70](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L70)
88
88
 
89
89
  ___
90
90
 
@@ -96,23 +96,29 @@ ___
96
96
 
97
97
  `IDropTemporaryTableQueryInput`
98
98
 
99
+ parameters that was passed into the constructor.
100
+
99
101
  #### Overrides
100
102
 
101
103
  [Query](Query.md).[getParameters](Query.md#getparameters)
102
104
 
103
105
  #### Defined in
104
106
 
105
- [src/DropTemporaryTableQuery.ts:25](https://github.com/breautek/storm/blob/186ee78/src/DropTemporaryTableQuery.ts#L25)
107
+ [src/DropTemporaryTableQuery.ts:25](https://github.com/breautek/storm/blob/f198938/src/DropTemporaryTableQuery.ts#L25)
106
108
 
107
109
  ___
108
110
 
109
111
  ### getParametersForQuery
110
112
 
111
- ▸ **getParametersForQuery**(): `IDictionary`<`any`\>
113
+ ▸ **getParametersForQuery**(): `Record`<`any`, `any`\>
114
+
115
+ Query implementations may override this API to augment the parameters.
112
116
 
113
117
  #### Returns
114
118
 
115
- `IDictionary`<`any`\>
119
+ `Record`<`any`, `any`\>
120
+
121
+ parameters that will be used when this query is ran.
116
122
 
117
123
  #### Inherited from
118
124
 
@@ -120,7 +126,7 @@ ___
120
126
 
121
127
  #### Defined in
122
128
 
123
- [src/Query.ts:31](https://github.com/breautek/storm/blob/186ee78/src/Query.ts#L31)
129
+ [src/Query.ts:38](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L38)
124
130
 
125
131
  ___
126
132
 
@@ -144,7 +150,7 @@ ___
144
150
 
145
151
  #### Defined in
146
152
 
147
- [src/Query.ts:37](https://github.com/breautek/storm/blob/186ee78/src/Query.ts#L37)
153
+ [src/Query.ts:44](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L44)
148
154
 
149
155
  ___
150
156
 
@@ -171,7 +177,7 @@ Override to augment/manipulate the returned result set.
171
177
 
172
178
  #### Defined in
173
179
 
174
- [src/Query.ts:58](https://github.com/breautek/storm/blob/186ee78/src/Query.ts#L58)
180
+ [src/Query.ts:65](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L65)
175
181
 
176
182
  ___
177
183
 
@@ -198,4 +204,4 @@ Can be used to set session variables or create temporary tables, etc.
198
204
 
199
205
  #### Defined in
200
206
 
201
- [src/Query.ts:48](https://github.com/breautek/storm/blob/186ee78/src/Query.ts#L48)
207
+ [src/Query.ts:55](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L55)
package/docs/classes/DumpStream.md CHANGED
@@ -20,4 +20,4 @@
20
20
 
21
21
  #### Defined in
22
22
 
23
- [src/DumpStream.ts:25](https://github.com/breautek/storm/blob/186ee78/src/DumpStream.ts#L25)
23
+ [src/DumpStream.ts:25](https://github.com/breautek/storm/blob/f198938/src/DumpStream.ts#L25)
package/docs/classes/DuplicateEntryError.md CHANGED
@@ -53,7 +53,7 @@
53
53
 
54
54
  #### Defined in
55
55
 
56
- [src/DuplicateEntryError.ts:28](https://github.com/breautek/storm/blob/186ee78/src/DuplicateEntryError.ts#L28)
56
+ [src/DuplicateEntryError.ts:28](https://github.com/breautek/storm/blob/f198938/src/DuplicateEntryError.ts#L28)
57
57
 
58
58
  ## Properties
59
59
 
@@ -67,7 +67,7 @@
67
67
 
68
68
  #### Defined in
69
69
 
70
- node_modules/typescript/lib/lib.es5.d.ts:1023
70
+ node_modules/typescript/lib/lib.es5.d.ts:1029
71
71
 
72
72
  ___
73
73
 
@@ -81,7 +81,7 @@ ___
81
81
 
82
82
  #### Defined in
83
83
 
84
- node_modules/typescript/lib/lib.es5.d.ts:1022
84
+ node_modules/typescript/lib/lib.es5.d.ts:1028
85
85
 
86
86
  ___
87
87
 
@@ -95,7 +95,7 @@ ___
95
95
 
96
96
  #### Defined in
97
97
 
98
- node_modules/typescript/lib/lib.es5.d.ts:1024
98
+ node_modules/typescript/lib/lib.es5.d.ts:1030
99
99
 
100
100
  ___
101
101
 
@@ -160,7 +160,7 @@ node_modules/@types/node/globals.d.ts:13
160
160
 
161
161
  #### Defined in
162
162
 
163
- [src/DuplicateEntryError.ts:41](https://github.com/breautek/storm/blob/186ee78/src/DuplicateEntryError.ts#L41)
163
+ [src/DuplicateEntryError.ts:41](https://github.com/breautek/storm/blob/f198938/src/DuplicateEntryError.ts#L41)
164
164
 
165
165
  ___
166
166
 
@@ -178,7 +178,7 @@ ___
178
178
 
179
179
  #### Defined in
180
180
 
181
- [src/StormError.ts:70](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L70)
181
+ [src/StormError.ts:70](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L70)
182
182
 
183
183
  ___
184
184
 
@@ -196,7 +196,7 @@ ___
196
196
 
197
197
  #### Defined in
198
198
 
199
- [src/StormError.ts:79](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L79)
199
+ [src/StormError.ts:79](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L79)
200
200
 
201
201
  ___
202
202
 
@@ -214,7 +214,7 @@ ___
214
214
 
215
215
  #### Defined in
216
216
 
217
- [src/DuplicateEntryError.ts:45](https://github.com/breautek/storm/blob/186ee78/src/DuplicateEntryError.ts#L45)
217
+ [src/DuplicateEntryError.ts:45](https://github.com/breautek/storm/blob/f198938/src/DuplicateEntryError.ts#L45)
218
218
 
219
219
  ___
220
220
 
@@ -232,7 +232,7 @@ ___
232
232
 
233
233
  #### Defined in
234
234
 
235
- [src/DuplicateEntryError.ts:36](https://github.com/breautek/storm/blob/186ee78/src/DuplicateEntryError.ts#L36)
235
+ [src/DuplicateEntryError.ts:36](https://github.com/breautek/storm/blob/f198938/src/DuplicateEntryError.ts#L36)
236
236
 
237
237
  ___
238
238
 
@@ -253,7 +253,7 @@ They are kept secret from the client.
253
253
 
254
254
  #### Defined in
255
255
 
256
- [src/StormError.ts:62](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L62)
256
+ [src/StormError.ts:62](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L62)
257
257
 
258
258
  ___
259
259
 
@@ -273,7 +273,7 @@ Sends details to the client.
273
273
 
274
274
  #### Defined in
275
275
 
276
- [src/StormError.ts:54](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L54)
276
+ [src/StormError.ts:54](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L54)
277
277
 
278
278
  ___
279
279
 
package/docs/classes/EntityNotFoundError.md CHANGED
@@ -51,7 +51,7 @@
51
51
 
52
52
  #### Defined in
53
53
 
54
- [src/EntityNotFoundError.ts:22](https://github.com/breautek/storm/blob/186ee78/src/EntityNotFoundError.ts#L22)
54
+ [src/EntityNotFoundError.ts:22](https://github.com/breautek/storm/blob/f198938/src/EntityNotFoundError.ts#L22)
55
55
 
56
56
  ## Properties
57
57
 
@@ -65,7 +65,7 @@
65
65
 
66
66
  #### Defined in
67
67
 
68
- node_modules/typescript/lib/lib.es5.d.ts:1023
68
+ node_modules/typescript/lib/lib.es5.d.ts:1029
69
69
 
70
70
  ___
71
71
 
@@ -79,7 +79,7 @@ ___
79
79
 
80
80
  #### Defined in
81
81
 
82
- node_modules/typescript/lib/lib.es5.d.ts:1022
82
+ node_modules/typescript/lib/lib.es5.d.ts:1028
83
83
 
84
84
  ___
85
85
 
@@ -93,7 +93,7 @@ ___
93
93
 
94
94
  #### Defined in
95
95
 
96
- node_modules/typescript/lib/lib.es5.d.ts:1024
96
+ node_modules/typescript/lib/lib.es5.d.ts:1030
97
97
 
98
98
  ___
99
99
 
@@ -158,7 +158,7 @@ node_modules/@types/node/globals.d.ts:13
158
158
 
159
159
  #### Defined in
160
160
 
161
- [src/EntityNotFoundError.ts:30](https://github.com/breautek/storm/blob/186ee78/src/EntityNotFoundError.ts#L30)
161
+ [src/EntityNotFoundError.ts:30](https://github.com/breautek/storm/blob/f198938/src/EntityNotFoundError.ts#L30)
162
162
 
163
163
  ___
164
164
 
@@ -176,7 +176,7 @@ ___
176
176
 
177
177
  #### Defined in
178
178
 
179
- [src/StormError.ts:70](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L70)
179
+ [src/StormError.ts:70](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L70)
180
180
 
181
181
  ___
182
182
 
@@ -194,7 +194,7 @@ ___
194
194
 
195
195
  #### Defined in
196
196
 
197
- [src/StormError.ts:79](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L79)
197
+ [src/StormError.ts:79](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L79)
198
198
 
199
199
  ___
200
200
 
@@ -212,7 +212,7 @@ ___
212
212
 
213
213
  #### Defined in
214
214
 
215
- [src/EntityNotFoundError.ts:34](https://github.com/breautek/storm/blob/186ee78/src/EntityNotFoundError.ts#L34)
215
+ [src/EntityNotFoundError.ts:34](https://github.com/breautek/storm/blob/f198938/src/EntityNotFoundError.ts#L34)
216
216
 
217
217
  ___
218
218
 
@@ -230,7 +230,7 @@ ___
230
230
 
231
231
  #### Defined in
232
232
 
233
- [src/EntityNotFoundError.ts:26](https://github.com/breautek/storm/blob/186ee78/src/EntityNotFoundError.ts#L26)
233
+ [src/EntityNotFoundError.ts:26](https://github.com/breautek/storm/blob/f198938/src/EntityNotFoundError.ts#L26)
234
234
 
235
235
  ___
236
236
 
@@ -251,7 +251,7 @@ They are kept secret from the client.
251
251
 
252
252
  #### Defined in
253
253
 
254
- [src/StormError.ts:62](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L62)
254
+ [src/StormError.ts:62](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L62)
255
255
 
256
256
  ___
257
257
 
@@ -271,7 +271,7 @@ Sends details to the client.
271
271
 
272
272
  #### Defined in
273
273
 
274
- [src/StormError.ts:54](https://github.com/breautek/storm/blob/186ee78/src/StormError.ts#L54)
274
+ [src/StormError.ts:54](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L54)
275
275
 
276
276
  ___
277
277