@breautek/storm 4.1.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 (201) hide show
  1. package/CHANGELOG.md +8 -1
  2. package/docs/README.md +6 -4
  3. package/docs/classes/Application.md +26 -26
  4. package/docs/classes/BackendAuthenticationMiddleware.md +2 -2
  5. package/docs/classes/CORSMiddleware.md +6 -6
  6. package/docs/classes/ConfigLoader.md +1 -1
  7. package/docs/classes/Database.md +12 -12
  8. package/docs/classes/DatabaseConnection.md +19 -19
  9. package/docs/classes/DatabaseQueryError.md +8 -8
  10. package/docs/classes/DiskSpaceError.md +8 -8
  11. package/docs/classes/DropTemporaryTableQuery.md +14 -8
  12. package/docs/classes/DumpStream.md +1 -1
  13. package/docs/classes/DuplicateEntryError.md +8 -8
  14. package/docs/classes/EntityNotFoundError.md +8 -8
  15. package/docs/classes/ExpiredTokenError.md +8 -8
  16. package/docs/classes/Handler.md +22 -22
  17. package/docs/classes/InternalError.md +8 -8
  18. package/docs/classes/InvalidCredentialsError.md +8 -8
  19. package/docs/classes/InvalidValueError.md +8 -8
  20. package/docs/classes/ManagedDatabaseConnection.md +19 -19
  21. package/docs/classes/Middleware.md +3 -3
  22. package/docs/classes/MissingConfigError.md +8 -8
  23. package/docs/classes/MissingParameterError.md +8 -8
  24. package/docs/classes/MySQLConnection.md +20 -20
  25. package/docs/classes/MySQLDatabase.md +13 -13
  26. package/docs/classes/NotImplementedError.md +301 -0
  27. package/docs/classes/Query.md +14 -8
  28. package/docs/classes/RawError.md +313 -0
  29. package/docs/classes/RawQuery.md +14 -8
  30. package/docs/classes/Request.md +18 -18
  31. package/docs/classes/Response.md +11 -11
  32. package/docs/classes/ResponseData.md +7 -7
  33. package/docs/classes/ServiceProvider.md +15 -15
  34. package/docs/classes/ServiceResponse.md +4 -4
  35. package/docs/classes/SetSessionVariableQuery.md +14 -8
  36. package/docs/classes/StormError.md +12 -8
  37. package/docs/classes/TemporaryTableQuery.md +14 -8
  38. package/docs/classes/Token.md +2 -2
  39. package/docs/classes/TokenManager.md +4 -4
  40. package/docs/classes/UnauthorizedAccessError.md +8 -8
  41. package/docs/enums/ErrorCode.md +9 -9
  42. package/docs/enums/ExitCode.md +2 -2
  43. package/docs/enums/HTTPMethod.md +4 -4
  44. package/docs/enums/JWTError.md +2 -2
  45. package/docs/enums/StatusCode.md +48 -48
  46. package/docs/interfaces/IConfig.md +8 -8
  47. package/docs/interfaces/IDatabaseConfig.md +6 -6
  48. package/docs/interfaces/IDatabaseConnection.md +14 -14
  49. package/docs/interfaces/IErrorResponse.md +4 -4
  50. package/docs/interfaces/IFormData.md +2 -2
  51. package/docs/interfaces/IHandler.md +1 -1
  52. package/docs/interfaces/IInsertQueryResult.md +3 -3
  53. package/docs/interfaces/IJWTVerifyOptions.md +1 -1
  54. package/docs/interfaces/IRequestResponse.md +2 -2
  55. package/docs/interfaces/ISetSessionVariableQueryInput.md +2 -2
  56. package/docs/interfaces/ITemporaryTableQueryInput.md +2 -2
  57. package/docs/interfaces/IUpdateQueryResult.md +2 -2
  58. package/lib/Application.d.ts +58 -0
  59. package/lib/Application.js +73 -0
  60. package/lib/Application.js.map +1 -1
  61. package/lib/ApplicationEvent.js +15 -0
  62. package/lib/ApplicationEvent.js.map +1 -1
  63. package/lib/BackendAuthenticationMiddleware.d.ts +12 -0
  64. package/lib/BackendAuthenticationMiddleware.js +28 -0
  65. package/lib/BackendAuthenticationMiddleware.js.map +1 -1
  66. package/lib/CORSMiddleware.d.ts +14 -0
  67. package/lib/CORSMiddleware.js +29 -0
  68. package/lib/CORSMiddleware.js.map +1 -1
  69. package/lib/ConfigLoader.js +16 -0
  70. package/lib/ConfigLoader.js.map +1 -1
  71. package/lib/Database.js +15 -0
  72. package/lib/Database.js.map +1 -1
  73. package/lib/DatabaseConnection.d.ts +115 -0
  74. package/lib/DatabaseConnection.js +71 -0
  75. package/lib/DatabaseConnection.js.map +1 -1
  76. package/lib/DatabaseQueryError.js +16 -0
  77. package/lib/DatabaseQueryError.js.map +1 -1
  78. package/lib/DiskSpaceError.js +15 -0
  79. package/lib/DiskSpaceError.js.map +1 -1
  80. package/lib/DropTemporaryTableQuery.js +15 -0
  81. package/lib/DropTemporaryTableQuery.js.map +1 -1
  82. package/lib/DumpStream.js +16 -0
  83. package/lib/DumpStream.js.map +1 -1
  84. package/lib/DuplicateEntryError.js +15 -0
  85. package/lib/DuplicateEntryError.js.map +1 -1
  86. package/lib/EntityNotFoundError.js +15 -0
  87. package/lib/EntityNotFoundError.js.map +1 -1
  88. package/lib/ErrorCode.js +15 -0
  89. package/lib/ErrorCode.js.map +1 -1
  90. package/lib/ExitCode.js +15 -0
  91. package/lib/ExitCode.js.map +1 -1
  92. package/lib/ExpiredTokenError.js +16 -0
  93. package/lib/ExpiredTokenError.js.map +1 -1
  94. package/lib/HTTPMethod.js +15 -0
  95. package/lib/HTTPMethod.js.map +1 -1
  96. package/lib/Handler.d.ts +22 -4
  97. package/lib/Handler.js +22 -6
  98. package/lib/Handler.js.map +1 -1
  99. package/lib/IAuthTokenData.js +15 -0
  100. package/lib/IAuthTokenData.js.map +1 -1
  101. package/lib/IConfig.js +15 -0
  102. package/lib/IConfig.js.map +1 -1
  103. package/lib/IDatabaseConfig.js +15 -0
  104. package/lib/IDatabaseConfig.js.map +1 -1
  105. package/lib/IDatabaseConnection.js +15 -0
  106. package/lib/IDatabaseConnection.js.map +1 -1
  107. package/lib/IDeleteQueryResult.js +15 -0
  108. package/lib/IDeleteQueryResult.js.map +1 -1
  109. package/lib/IFormData.js +15 -0
  110. package/lib/IFormData.js.map +1 -1
  111. package/lib/IHandler.js +15 -0
  112. package/lib/IHandler.js.map +1 -1
  113. package/lib/IInsertQueryResult.js +15 -0
  114. package/lib/IInsertQueryResult.js.map +1 -1
  115. package/lib/IJWTVerifyOptions.js +15 -0
  116. package/lib/IJWTVerifyOptions.js.map +1 -1
  117. package/lib/IRequestResponse.js +15 -0
  118. package/lib/IRequestResponse.js.map +1 -1
  119. package/lib/IServiceHeaders.js +15 -0
  120. package/lib/IServiceHeaders.js.map +1 -1
  121. package/lib/IUpdateQueryResult.js +15 -0
  122. package/lib/IUpdateQueryResult.js.map +1 -1
  123. package/lib/InternalError.js +16 -0
  124. package/lib/InternalError.js.map +1 -1
  125. package/lib/InvalidConfigError.js +15 -0
  126. package/lib/InvalidConfigError.js.map +1 -1
  127. package/lib/InvalidCredentialsError.js +16 -0
  128. package/lib/InvalidCredentialsError.js.map +1 -1
  129. package/lib/InvalidValueError.js +16 -0
  130. package/lib/InvalidValueError.js.map +1 -1
  131. package/lib/JWTError.js +15 -0
  132. package/lib/JWTError.js.map +1 -1
  133. package/lib/JWTVerifyOptionsParser.js +16 -0
  134. package/lib/JWTVerifyOptionsParser.js.map +1 -1
  135. package/lib/ManagedDatabaseConnection.d.ts +5 -0
  136. package/lib/ManagedDatabaseConnection.js +26 -0
  137. package/lib/ManagedDatabaseConnection.js.map +1 -1
  138. package/lib/Middleware.js +16 -0
  139. package/lib/Middleware.js.map +1 -1
  140. package/lib/MissingConfigError.js +15 -0
  141. package/lib/MissingConfigError.js.map +1 -1
  142. package/lib/MissingParameterError.js +15 -0
  143. package/lib/MissingParameterError.js.map +1 -1
  144. package/lib/MySQLConnection.js +24 -1
  145. package/lib/MySQLConnection.js.map +1 -1
  146. package/lib/MySQLDatabase.js +18 -0
  147. package/lib/MySQLDatabase.js.map +1 -1
  148. package/lib/NotImplementedError.d.ts +14 -0
  149. package/lib/NotImplementedError.js +40 -0
  150. package/lib/NotImplementedError.js.map +1 -0
  151. package/lib/Query.d.ts +21 -0
  152. package/lib/Query.js +37 -0
  153. package/lib/Query.js.map +1 -1
  154. package/lib/RawError.d.ts +14 -0
  155. package/lib/RawError.js +40 -0
  156. package/lib/RawError.js.map +1 -0
  157. package/lib/RawQuery.js +15 -0
  158. package/lib/RawQuery.js.map +1 -1
  159. package/lib/Request.js +15 -0
  160. package/lib/Request.js.map +1 -1
  161. package/lib/Response.js +17 -0
  162. package/lib/Response.js.map +1 -1
  163. package/lib/ResponseData.js +15 -0
  164. package/lib/ResponseData.js.map +1 -1
  165. package/lib/ServiceProvider.js +20 -0
  166. package/lib/ServiceProvider.js.map +1 -1
  167. package/lib/ServiceResponse.js +15 -0
  168. package/lib/ServiceResponse.js.map +1 -1
  169. package/lib/SetSessionVariableQuery.js +1 -0
  170. package/lib/SetSessionVariableQuery.js.map +1 -1
  171. package/lib/StatusCode.js +15 -0
  172. package/lib/StatusCode.js.map +1 -1
  173. package/lib/StormError.d.ts +7 -0
  174. package/lib/StormError.js +22 -0
  175. package/lib/StormError.js.map +1 -1
  176. package/lib/TemporaryTableQuery.js +15 -0
  177. package/lib/TemporaryTableQuery.js.map +1 -1
  178. package/lib/Token.js +15 -0
  179. package/lib/Token.js.map +1 -1
  180. package/lib/TokenManager.js +17 -0
  181. package/lib/TokenManager.js.map +1 -1
  182. package/lib/UnauthorizedAccessError.js +15 -0
  183. package/lib/UnauthorizedAccessError.js.map +1 -1
  184. package/lib/api.d.ts +2 -0
  185. package/lib/api.js +28 -1
  186. package/lib/api.js.map +1 -1
  187. package/lib/instance.js +15 -0
  188. package/lib/instance.js.map +1 -1
  189. package/lib/private/CommitQuery.js +15 -0
  190. package/lib/private/CommitQuery.js.map +1 -1
  191. package/lib/private/RollbackQuery.js +15 -0
  192. package/lib/private/RollbackQuery.js.map +1 -1
  193. package/lib/private/StartTransactionQuery.js +15 -0
  194. package/lib/private/StartTransactionQuery.js.map +1 -1
  195. package/package.json +1 -1
  196. package/src/Handler.ts +10 -9
  197. package/src/NotImplementedError.ts +45 -0
  198. package/src/Query.ts +8 -0
  199. package/src/RawError.ts +39 -0
  200. package/src/api.ts +2 -0
  201. package/tsconfig.json +0 -1
package/docs/classes/ServiceProvider.md CHANGED
@@ -39,7 +39,7 @@
39
39
 
40
40
  #### Defined in
41
41
 
42
- [src/ServiceProvider.ts:29](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L29)
42
+ [src/ServiceProvider.ts:29](https://github.com/breautek/storm/blob/f198938/src/ServiceProvider.ts#L29)
43
43
 
44
44
  ## Methods
45
45
 
@@ -60,7 +60,7 @@
60
60
 
61
61
  #### Defined in
62
62
 
63
- [src/ServiceProvider.ts:64](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L64)
63
+ [src/ServiceProvider.ts:64](https://github.com/breautek/storm/blob/f198938/src/ServiceProvider.ts#L64)
64
64
 
65
65
  ___
66
66
 
@@ -74,7 +74,7 @@ ___
74
74
 
75
75
  #### Defined in
76
76
 
77
- [src/ServiceProvider.ts:36](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L36)
77
+ [src/ServiceProvider.ts:36](https://github.com/breautek/storm/blob/f198938/src/ServiceProvider.ts#L36)
78
78
 
79
79
  ___
80
80
 
@@ -88,7 +88,7 @@ ___
88
88
 
89
89
  #### Defined in
90
90
 
91
- [src/ServiceProvider.ts:33](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L33)
91
+ [src/ServiceProvider.ts:33](https://github.com/breautek/storm/blob/f198938/src/ServiceProvider.ts#L33)
92
92
 
93
93
  ___
94
94
 
@@ -102,7 +102,7 @@ ___
102
102
 
103
103
  #### Defined in
104
104
 
105
- [src/ServiceProvider.ts:44](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L44)
105
+ [src/ServiceProvider.ts:44](https://github.com/breautek/storm/blob/f198938/src/ServiceProvider.ts#L44)
106
106
 
107
107
  ___
108
108
 
@@ -116,7 +116,7 @@ ___
116
116
 
117
117
  #### Defined in
118
118
 
119
- [src/ServiceProvider.ts:34](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L34)
119
+ [src/ServiceProvider.ts:34](https://github.com/breautek/storm/blob/f198938/src/ServiceProvider.ts#L34)
120
120
 
121
121
  ___
122
122
 
@@ -130,7 +130,7 @@ ___
130
130
 
131
131
  #### Defined in
132
132
 
133
- [src/ServiceProvider.ts:56](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L56)
133
+ [src/ServiceProvider.ts:56](https://github.com/breautek/storm/blob/f198938/src/ServiceProvider.ts#L56)
134
134
 
135
135
  ___
136
136
 
@@ -154,7 +154,7 @@ ___
154
154
 
155
155
  #### Defined in
156
156
 
157
- [src/ServiceProvider.ts:157](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L157)
157
+ [src/ServiceProvider.ts:157](https://github.com/breautek/storm/blob/f198938/src/ServiceProvider.ts#L157)
158
158
 
159
159
  ___
160
160
 
@@ -178,7 +178,7 @@ ___
178
178
 
179
179
  #### Defined in
180
180
 
181
- [src/ServiceProvider.ts:142](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L142)
181
+ [src/ServiceProvider.ts:142](https://github.com/breautek/storm/blob/f198938/src/ServiceProvider.ts#L142)
182
182
 
183
183
  ___
184
184
 
@@ -192,7 +192,7 @@ ___
192
192
 
193
193
  #### Defined in
194
194
 
195
- [src/ServiceProvider.ts:40](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L40)
195
+ [src/ServiceProvider.ts:40](https://github.com/breautek/storm/blob/f198938/src/ServiceProvider.ts#L40)
196
196
 
197
197
  ___
198
198
 
@@ -206,7 +206,7 @@ ___
206
206
 
207
207
  #### Defined in
208
208
 
209
- [src/ServiceProvider.ts:60](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L60)
209
+ [src/ServiceProvider.ts:60](https://github.com/breautek/storm/blob/f198938/src/ServiceProvider.ts#L60)
210
210
 
211
211
  ___
212
212
 
@@ -230,7 +230,7 @@ ___
230
230
 
231
231
  #### Defined in
232
232
 
233
- [src/ServiceProvider.ts:147](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L147)
233
+ [src/ServiceProvider.ts:147](https://github.com/breautek/storm/blob/f198938/src/ServiceProvider.ts#L147)
234
234
 
235
235
  ___
236
236
 
@@ -254,7 +254,7 @@ ___
254
254
 
255
255
  #### Defined in
256
256
 
257
- [src/ServiceProvider.ts:152](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L152)
257
+ [src/ServiceProvider.ts:152](https://github.com/breautek/storm/blob/f198938/src/ServiceProvider.ts#L152)
258
258
 
259
259
  ___
260
260
 
@@ -279,7 +279,7 @@ ___
279
279
 
280
280
  #### Defined in
281
281
 
282
- [src/ServiceProvider.ts:82](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L82)
282
+ [src/ServiceProvider.ts:82](https://github.com/breautek/storm/blob/f198938/src/ServiceProvider.ts#L82)
283
283
 
284
284
  ___
285
285
 
@@ -293,4 +293,4 @@ ___
293
293
 
294
294
  #### Defined in
295
295
 
296
- [src/ServiceProvider.ts:52](https://github.com/breautek/storm/blob/3ad3438/src/ServiceProvider.ts#L52)
296
+ [src/ServiceProvider.ts:52](https://github.com/breautek/storm/blob/f198938/src/ServiceProvider.ts#L52)
package/docs/classes/ServiceResponse.md CHANGED
@@ -29,7 +29,7 @@
29
29
 
30
30
  #### Defined in
31
31
 
32
- [src/ServiceResponse.ts:23](https://github.com/breautek/storm/blob/3ad3438/src/ServiceResponse.ts#L23)
32
+ [src/ServiceResponse.ts:23](https://github.com/breautek/storm/blob/f198938/src/ServiceResponse.ts#L23)
33
33
 
34
34
  ## Methods
35
35
 
@@ -43,7 +43,7 @@
43
43
 
44
44
  #### Defined in
45
45
 
46
- [src/ServiceResponse.ts:36](https://github.com/breautek/storm/blob/3ad3438/src/ServiceResponse.ts#L36)
46
+ [src/ServiceResponse.ts:36](https://github.com/breautek/storm/blob/f198938/src/ServiceResponse.ts#L36)
47
47
 
48
48
  ___
49
49
 
@@ -57,7 +57,7 @@ ___
57
57
 
58
58
  #### Defined in
59
59
 
60
- [src/ServiceResponse.ts:28](https://github.com/breautek/storm/blob/3ad3438/src/ServiceResponse.ts#L28)
60
+ [src/ServiceResponse.ts:28](https://github.com/breautek/storm/blob/f198938/src/ServiceResponse.ts#L28)
61
61
 
62
62
  ___
63
63
 
@@ -71,4 +71,4 @@ ___
71
71
 
72
72
  #### Defined in
73
73
 
74
- [src/ServiceResponse.ts:32](https://github.com/breautek/storm/blob/3ad3438/src/ServiceResponse.ts#L32)
74
+ [src/ServiceResponse.ts:32](https://github.com/breautek/storm/blob/f198938/src/ServiceResponse.ts#L32)
package/docs/classes/SetSessionVariableQuery.md CHANGED
@@ -42,7 +42,7 @@
42
42
 
43
43
  #### Defined in
44
44
 
45
- [src/Query.ts:22](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L22)
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/SetSessionVariableQuery.ts:12](https://github.com/breautek/storm/blob/3ad3438/src/SetSessionVariableQuery.ts#L12)
63
+ [src/SetSessionVariableQuery.ts:12](https://github.com/breautek/storm/blob/f198938/src/SetSessionVariableQuery.ts#L12)
64
64
 
65
65
  ___
66
66
 
@@ -84,7 +84,7 @@ ___
84
84
 
85
85
  #### Defined in
86
86
 
87
- [src/Query.ts:62](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L62)
87
+ [src/Query.ts:70](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L70)
88
88
 
89
89
  ___
90
90
 
@@ -96,13 +96,15 @@ ___
96
96
 
97
97
  [`ISetSessionVariableQueryInput`](../interfaces/ISetSessionVariableQueryInput.md)
98
98
 
99
+ parameters that was passed into the constructor.
100
+
99
101
  #### Inherited from
100
102
 
101
103
  [Query](Query.md).[getParameters](Query.md#getparameters)
102
104
 
103
105
  #### Defined in
104
106
 
105
- [src/Query.ts:26](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L26)
107
+ [src/Query.ts:29](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L29)
106
108
 
107
109
  ___
108
110
 
@@ -110,17 +112,21 @@ ___
110
112
 
111
113
  ▸ **getParametersForQuery**(): `Record`<`any`, `any`\>
112
114
 
115
+ Query implementations may override this API to augment the parameters.
116
+
113
117
  #### Returns
114
118
 
115
119
  `Record`<`any`, `any`\>
116
120
 
121
+ parameters that will be used when this query is ran.
122
+
117
123
  #### Overrides
118
124
 
119
125
  [Query](Query.md).[getParametersForQuery](Query.md#getparametersforquery)
120
126
 
121
127
  #### Defined in
122
128
 
123
- [src/SetSessionVariableQuery.ts:23](https://github.com/breautek/storm/blob/3ad3438/src/SetSessionVariableQuery.ts#L23)
129
+ [src/SetSessionVariableQuery.ts:23](https://github.com/breautek/storm/blob/f198938/src/SetSessionVariableQuery.ts#L23)
124
130
 
125
131
  ___
126
132
 
@@ -144,7 +150,7 @@ ___
144
150
 
145
151
  #### Defined in
146
152
 
147
- [src/Query.ts:36](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L36)
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:57](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L57)
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:47](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L47)
207
+ [src/Query.ts:55](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L55)
package/docs/classes/StormError.md CHANGED
@@ -14,6 +14,8 @@
14
14
 
15
15
  ↳ **`StormError`**
16
16
 
17
+ ↳↳ [`RawError`](RawError.md)
18
+
17
19
  ↳↳ [`MissingParameterError`](MissingParameterError.md)
18
20
 
19
21
  ↳↳ [`InvalidCredentialsError`](InvalidCredentialsError.md)
@@ -36,6 +38,8 @@
36
38
 
37
39
  ↳↳ [`DatabaseQueryError`](DatabaseQueryError.md)
38
40
 
41
+ ↳↳ [`NotImplementedError`](NotImplementedError.md)
42
+
39
43
  ## Table of contents
40
44
 
41
45
  ### Constructors
@@ -85,7 +89,7 @@ Error.constructor
85
89
 
86
90
  #### Defined in
87
91
 
88
- [src/StormError.ts:38](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L38)
92
+ [src/StormError.ts:38](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L38)
89
93
 
90
94
  ## Properties
91
95
 
@@ -188,7 +192,7 @@ node_modules/@types/node/globals.d.ts:13
188
192
 
189
193
  #### Defined in
190
194
 
191
- [src/StormError.ts:49](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L49)
195
+ [src/StormError.ts:49](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L49)
192
196
 
193
197
  ___
194
198
 
@@ -202,7 +206,7 @@ ___
202
206
 
203
207
  #### Defined in
204
208
 
205
- [src/StormError.ts:70](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L70)
209
+ [src/StormError.ts:70](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L70)
206
210
 
207
211
  ___
208
212
 
@@ -216,7 +220,7 @@ ___
216
220
 
217
221
  #### Defined in
218
222
 
219
- [src/StormError.ts:79](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L79)
223
+ [src/StormError.ts:79](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L79)
220
224
 
221
225
  ___
222
226
 
@@ -230,7 +234,7 @@ ___
230
234
 
231
235
  #### Defined in
232
236
 
233
- [src/StormError.ts:66](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L66)
237
+ [src/StormError.ts:66](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L66)
234
238
 
235
239
  ___
236
240
 
@@ -244,7 +248,7 @@ ___
244
248
 
245
249
  #### Defined in
246
250
 
247
- [src/StormError.ts:48](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L48)
251
+ [src/StormError.ts:48](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L48)
248
252
 
249
253
  ___
250
254
 
@@ -261,7 +265,7 @@ They are kept secret from the client.
261
265
 
262
266
  #### Defined in
263
267
 
264
- [src/StormError.ts:62](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L62)
268
+ [src/StormError.ts:62](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L62)
265
269
 
266
270
  ___
267
271
 
@@ -277,7 +281,7 @@ Sends details to the client.
277
281
 
278
282
  #### Defined in
279
283
 
280
- [src/StormError.ts:54](https://github.com/breautek/storm/blob/3ad3438/src/StormError.ts#L54)
284
+ [src/StormError.ts:54](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L54)
281
285
 
282
286
  ___
283
287
 
package/docs/classes/TemporaryTableQuery.md CHANGED
@@ -42,7 +42,7 @@
42
42
 
43
43
  #### Defined in
44
44
 
45
- [src/Query.ts:22](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L22)
45
+ [src/Query.ts:22](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L22)
46
46
 
47
47
  ## Methods
48
48
 
@@ -66,7 +66,7 @@
66
66
 
67
67
  #### Defined in
68
68
 
69
- [src/TemporaryTableQuery.ts:35](https://github.com/breautek/storm/blob/3ad3438/src/TemporaryTableQuery.ts#L35)
69
+ [src/TemporaryTableQuery.ts:35](https://github.com/breautek/storm/blob/f198938/src/TemporaryTableQuery.ts#L35)
70
70
 
71
71
  ___
72
72
 
@@ -90,7 +90,7 @@ ___
90
90
 
91
91
  #### Defined in
92
92
 
93
- [src/Query.ts:62](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L62)
93
+ [src/Query.ts:70](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L70)
94
94
 
95
95
  ___
96
96
 
@@ -102,13 +102,15 @@ ___
102
102
 
103
103
  `any`
104
104
 
105
+ parameters that was passed into the constructor.
106
+
105
107
  #### Inherited from
106
108
 
107
109
  [Query](Query.md).[getParameters](Query.md#getparameters)
108
110
 
109
111
  #### Defined in
110
112
 
111
- [src/Query.ts:26](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L26)
113
+ [src/Query.ts:29](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L29)
112
114
 
113
115
  ___
114
116
 
@@ -116,17 +118,21 @@ ___
116
118
 
117
119
  ▸ **getParametersForQuery**(): `Record`<`any`, `any`\>
118
120
 
121
+ Query implementations may override this API to augment the parameters.
122
+
119
123
  #### Returns
120
124
 
121
125
  `Record`<`any`, `any`\>
122
126
 
127
+ parameters that will be used when this query is ran.
128
+
123
129
  #### Overrides
124
130
 
125
131
  [Query](Query.md).[getParametersForQuery](Query.md#getparametersforquery)
126
132
 
127
133
  #### Defined in
128
134
 
129
- [src/TemporaryTableQuery.ts:27](https://github.com/breautek/storm/blob/3ad3438/src/TemporaryTableQuery.ts#L27)
135
+ [src/TemporaryTableQuery.ts:27](https://github.com/breautek/storm/blob/f198938/src/TemporaryTableQuery.ts#L27)
130
136
 
131
137
  ___
132
138
 
@@ -150,7 +156,7 @@ ___
150
156
 
151
157
  #### Defined in
152
158
 
153
- [src/Query.ts:36](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L36)
159
+ [src/Query.ts:44](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L44)
154
160
 
155
161
  ___
156
162
 
@@ -177,7 +183,7 @@ Override to augment/manipulate the returned result set.
177
183
 
178
184
  #### Defined in
179
185
 
180
- [src/Query.ts:57](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L57)
186
+ [src/Query.ts:65](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L65)
181
187
 
182
188
  ___
183
189
 
@@ -204,4 +210,4 @@ Can be used to set session variables or create temporary tables, etc.
204
210
 
205
211
  #### Defined in
206
212
 
207
- [src/Query.ts:47](https://github.com/breautek/storm/blob/3ad3438/src/Query.ts#L47)
213
+ [src/Query.ts:55](https://github.com/breautek/storm/blob/f198938/src/Query.ts#L55)
package/docs/classes/Token.md CHANGED
@@ -26,7 +26,7 @@
26
26
 
27
27
  #### Defined in
28
28
 
29
- [src/Token.ts:20](https://github.com/breautek/storm/blob/3ad3438/src/Token.ts#L20)
29
+ [src/Token.ts:20](https://github.com/breautek/storm/blob/f198938/src/Token.ts#L20)
30
30
 
31
31
  ## Methods
32
32
 
@@ -40,4 +40,4 @@
40
40
 
41
41
  #### Defined in
42
42
 
43
- [src/Token.ts:24](https://github.com/breautek/storm/blob/3ad3438/src/Token.ts#L24)
43
+ [src/Token.ts:24](https://github.com/breautek/storm/blob/f198938/src/Token.ts#L24)
package/docs/classes/TokenManager.md CHANGED
@@ -40,7 +40,7 @@
40
40
 
41
41
  #### Defined in
42
42
 
43
- [src/TokenManager.ts:29](https://github.com/breautek/storm/blob/3ad3438/src/TokenManager.ts#L29)
43
+ [src/TokenManager.ts:29](https://github.com/breautek/storm/blob/f198938/src/TokenManager.ts#L29)
44
44
 
45
45
  ## Methods
46
46
 
@@ -60,7 +60,7 @@
60
60
 
61
61
  #### Defined in
62
62
 
63
- [src/TokenManager.ts:78](https://github.com/breautek/storm/blob/3ad3438/src/TokenManager.ts#L78)
63
+ [src/TokenManager.ts:78](https://github.com/breautek/storm/blob/f198938/src/TokenManager.ts#L78)
64
64
 
65
65
  ___
66
66
 
@@ -81,7 +81,7 @@ ___
81
81
 
82
82
  #### Defined in
83
83
 
84
- [src/TokenManager.ts:33](https://github.com/breautek/storm/blob/3ad3438/src/TokenManager.ts#L33)
84
+ [src/TokenManager.ts:33](https://github.com/breautek/storm/blob/f198938/src/TokenManager.ts#L33)
85
85
 
86
86
  ___
87
87
 
@@ -102,4 +102,4 @@ ___
102
102
 
103
103
  #### Defined in
104
104
 
105
- [src/TokenManager.ts:56](https://github.com/breautek/storm/blob/3ad3438/src/TokenManager.ts#L56)
105
+ [src/TokenManager.ts:56](https://github.com/breautek/storm/blob/f198938/src/TokenManager.ts#L56)
package/docs/classes/UnauthorizedAccessError.md CHANGED
@@ -51,7 +51,7 @@
51
51
 
52
52
  #### Defined in
53
53
 
54
- [src/UnauthorizedAccessError.ts:22](https://github.com/breautek/storm/blob/3ad3438/src/UnauthorizedAccessError.ts#L22)
54
+ [src/UnauthorizedAccessError.ts:22](https://github.com/breautek/storm/blob/f198938/src/UnauthorizedAccessError.ts#L22)
55
55
 
56
56
  ## Properties
57
57
 
@@ -158,7 +158,7 @@ node_modules/@types/node/globals.d.ts:13
158
158
 
159
159
  #### Defined in
160
160
 
161
- [src/UnauthorizedAccessError.ts:30](https://github.com/breautek/storm/blob/3ad3438/src/UnauthorizedAccessError.ts#L30)
161
+ [src/UnauthorizedAccessError.ts:30](https://github.com/breautek/storm/blob/f198938/src/UnauthorizedAccessError.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/3ad3438/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/3ad3438/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/UnauthorizedAccessError.ts:34](https://github.com/breautek/storm/blob/3ad3438/src/UnauthorizedAccessError.ts#L34)
215
+ [src/UnauthorizedAccessError.ts:34](https://github.com/breautek/storm/blob/f198938/src/UnauthorizedAccessError.ts#L34)
216
216
 
217
217
  ___
218
218
 
@@ -230,7 +230,7 @@ ___
230
230
 
231
231
  #### Defined in
232
232
 
233
- [src/UnauthorizedAccessError.ts:26](https://github.com/breautek/storm/blob/3ad3438/src/UnauthorizedAccessError.ts#L26)
233
+ [src/UnauthorizedAccessError.ts:26](https://github.com/breautek/storm/blob/f198938/src/UnauthorizedAccessError.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/3ad3438/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/3ad3438/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/enums/ErrorCode.md CHANGED
@@ -24,7 +24,7 @@
24
24
 
25
25
  #### Defined in
26
26
 
27
- [src/ErrorCode.ts:23](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L23)
27
+ [src/ErrorCode.ts:23](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L23)
28
28
 
29
29
  ___
30
30
 
@@ -34,7 +34,7 @@ ___
34
34
 
35
35
  #### Defined in
36
36
 
37
- [src/ErrorCode.ts:20](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L20)
37
+ [src/ErrorCode.ts:20](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L20)
38
38
 
39
39
  ___
40
40
 
@@ -44,7 +44,7 @@ ___
44
44
 
45
45
  #### Defined in
46
46
 
47
- [src/ErrorCode.ts:25](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L25)
47
+ [src/ErrorCode.ts:25](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L25)
48
48
 
49
49
  ___
50
50
 
@@ -54,7 +54,7 @@ ___
54
54
 
55
55
  #### Defined in
56
56
 
57
- [src/ErrorCode.ts:18](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L18)
57
+ [src/ErrorCode.ts:18](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L18)
58
58
 
59
59
  ___
60
60
 
@@ -64,7 +64,7 @@ ___
64
64
 
65
65
  #### Defined in
66
66
 
67
- [src/ErrorCode.ts:26](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L26)
67
+ [src/ErrorCode.ts:26](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L26)
68
68
 
69
69
  ___
70
70
 
@@ -74,7 +74,7 @@ ___
74
74
 
75
75
  #### Defined in
76
76
 
77
- [src/ErrorCode.ts:21](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L21)
77
+ [src/ErrorCode.ts:21](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L21)
78
78
 
79
79
  ___
80
80
 
@@ -84,7 +84,7 @@ ___
84
84
 
85
85
  #### Defined in
86
86
 
87
- [src/ErrorCode.ts:22](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L22)
87
+ [src/ErrorCode.ts:22](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L22)
88
88
 
89
89
  ___
90
90
 
@@ -94,7 +94,7 @@ ___
94
94
 
95
95
  #### Defined in
96
96
 
97
- [src/ErrorCode.ts:19](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L19)
97
+ [src/ErrorCode.ts:19](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L19)
98
98
 
99
99
  ___
100
100
 
@@ -104,4 +104,4 @@ ___
104
104
 
105
105
  #### Defined in
106
106
 
107
- [src/ErrorCode.ts:24](https://github.com/breautek/storm/blob/3ad3438/src/ErrorCode.ts#L24)
107
+ [src/ErrorCode.ts:24](https://github.com/breautek/storm/blob/f198938/src/ErrorCode.ts#L24)
package/docs/enums/ExitCode.md CHANGED
@@ -17,7 +17,7 @@
17
17
 
18
18
  #### Defined in
19
19
 
20
- [src/ExitCode.ts:19](https://github.com/breautek/storm/blob/3ad3438/src/ExitCode.ts#L19)
20
+ [src/ExitCode.ts:19](https://github.com/breautek/storm/blob/f198938/src/ExitCode.ts#L19)
21
21
 
22
22
  ___
23
23
 
@@ -27,4 +27,4 @@ ___
27
27
 
28
28
  #### Defined in
29
29
 
30
- [src/ExitCode.ts:18](https://github.com/breautek/storm/blob/3ad3438/src/ExitCode.ts#L18)
30
+ [src/ExitCode.ts:18](https://github.com/breautek/storm/blob/f198938/src/ExitCode.ts#L18)
package/docs/enums/HTTPMethod.md CHANGED
@@ -19,7 +19,7 @@
19
19
 
20
20
  #### Defined in
21
21
 
22
- [src/HTTPMethod.ts:21](https://github.com/breautek/storm/blob/3ad3438/src/HTTPMethod.ts#L21)
22
+ [src/HTTPMethod.ts:21](https://github.com/breautek/storm/blob/f198938/src/HTTPMethod.ts#L21)
23
23
 
24
24
  ___
25
25
 
@@ -29,7 +29,7 @@ ___
29
29
 
30
30
  #### Defined in
31
31
 
32
- [src/HTTPMethod.ts:18](https://github.com/breautek/storm/blob/3ad3438/src/HTTPMethod.ts#L18)
32
+ [src/HTTPMethod.ts:18](https://github.com/breautek/storm/blob/f198938/src/HTTPMethod.ts#L18)
33
33
 
34
34
  ___
35
35
 
@@ -39,7 +39,7 @@ ___
39
39
 
40
40
  #### Defined in
41
41
 
42
- [src/HTTPMethod.ts:19](https://github.com/breautek/storm/blob/3ad3438/src/HTTPMethod.ts#L19)
42
+ [src/HTTPMethod.ts:19](https://github.com/breautek/storm/blob/f198938/src/HTTPMethod.ts#L19)
43
43
 
44
44
  ___
45
45
 
@@ -49,4 +49,4 @@ ___
49
49
 
50
50
  #### Defined in
51
51
 
52
- [src/HTTPMethod.ts:20](https://github.com/breautek/storm/blob/3ad3438/src/HTTPMethod.ts#L20)
52
+ [src/HTTPMethod.ts:20](https://github.com/breautek/storm/blob/f198938/src/HTTPMethod.ts#L20)