@breautek/storm 4.6.2 → 5.0.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 (105) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/docs/README.md +7 -5
  3. package/docs/classes/Application.md +53 -53
  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/DatabaseCastObject.md +3 -3
  9. package/docs/classes/DatabaseConnection.md +21 -21
  10. package/docs/classes/DatabaseQueryError.md +16 -16
  11. package/docs/classes/DeadLockError.md +16 -16
  12. package/docs/classes/DiskSpaceError.md +16 -16
  13. package/docs/classes/DropTemporaryTableQuery.md +10 -10
  14. package/docs/classes/DumpStream.md +1 -1
  15. package/docs/classes/DuplicateEntryError.md +16 -16
  16. package/docs/classes/EntityNotFoundError.md +16 -16
  17. package/docs/classes/ExpiredTokenError.md +16 -16
  18. package/docs/classes/Handler.md +13 -34
  19. package/docs/classes/InternalError.md +16 -16
  20. package/docs/classes/InvalidCredentialsError.md +16 -16
  21. package/docs/classes/InvalidValueError.md +16 -16
  22. package/docs/classes/LineString.md +4 -4
  23. package/docs/classes/ManagedDatabaseConnection.md +19 -19
  24. package/docs/classes/Middleware.md +3 -3
  25. package/docs/classes/MissingConfigError.md +16 -16
  26. package/docs/classes/MissingParameterError.md +16 -16
  27. package/docs/classes/MySQLConnection.md +22 -22
  28. package/docs/classes/MySQLDatabase.md +13 -13
  29. package/docs/classes/NotImplementedError.md +16 -16
  30. package/docs/classes/Point.md +4 -4
  31. package/docs/classes/Polygon.md +4 -4
  32. package/docs/classes/Query.md +34 -10
  33. package/docs/classes/RawError.md +16 -16
  34. package/docs/classes/RawQuery.md +10 -10
  35. package/docs/classes/Request.md +18 -18
  36. package/docs/classes/Response.md +11 -11
  37. package/docs/classes/ResponseData.md +7 -7
  38. package/docs/classes/ServiceProvider.md +15 -15
  39. package/docs/classes/ServiceResponse.md +19 -4
  40. package/docs/classes/SetSessionVariableQuery.md +8 -8
  41. package/docs/classes/StormError.md +16 -16
  42. package/docs/classes/TemporaryTableQuery.md +8 -8
  43. package/docs/classes/Token.md +2 -2
  44. package/docs/classes/TokenManager.md +4 -4
  45. package/docs/classes/Transaction.md +161 -0
  46. package/docs/classes/UnauthorizedAccessError.md +16 -16
  47. package/docs/enums/ErrorCode.md +9 -9
  48. package/docs/enums/ExitCode.md +2 -2
  49. package/docs/enums/HTTPMethod.md +4 -4
  50. package/docs/enums/IsolationLevel.md +4 -4
  51. package/docs/enums/JWTError.md +2 -2
  52. package/docs/enums/StatusCode.md +48 -48
  53. package/docs/interfaces/IConfig.md +8 -8
  54. package/docs/interfaces/IDatabaseConfig.md +6 -6
  55. package/docs/interfaces/IDatabaseConnection.md +16 -16
  56. package/docs/interfaces/IErrorResponse.md +5 -5
  57. package/docs/interfaces/IFormData.md +2 -2
  58. package/docs/interfaces/IHandler.md +1 -1
  59. package/docs/interfaces/IInsertQueryResult.md +3 -3
  60. package/docs/interfaces/IJWTVerifyOptions.md +1 -1
  61. package/docs/interfaces/IQueryable.md +119 -0
  62. package/docs/interfaces/IRequestResponse.md +2 -2
  63. package/docs/interfaces/ISetSessionVariableQueryInput.md +2 -2
  64. package/docs/interfaces/ITemporaryTableQueryInput.md +2 -2
  65. package/docs/interfaces/IUpdateQueryResult.md +2 -2
  66. package/docs/interfaces/formidable.Part.md +17 -17
  67. package/jest.config.js +9 -5
  68. package/lib/DatabaseConnection.d.ts +3 -3
  69. package/lib/DatabaseConnection.js.map +1 -1
  70. package/lib/Handler.d.ts +2 -3
  71. package/lib/Handler.js +0 -2
  72. package/lib/Handler.js.map +1 -1
  73. package/lib/IDatabaseConnection.d.ts +3 -3
  74. package/lib/IDeleteQueryResult.d.ts +1 -1
  75. package/lib/IQueryable.d.ts +8 -0
  76. package/lib/IQueryable.js +18 -0
  77. package/lib/IQueryable.js.map +1 -0
  78. package/lib/MySQLConnection.js +15 -4
  79. package/lib/MySQLConnection.js.map +1 -1
  80. package/lib/Query.d.ts +3 -2
  81. package/lib/Query.js.map +1 -1
  82. package/lib/Response.d.ts +1 -1
  83. package/lib/ServiceResponse.d.ts +2 -0
  84. package/lib/ServiceResponse.js +3 -0
  85. package/lib/ServiceResponse.js.map +1 -1
  86. package/lib/SetSessionVariableQuery.js +2 -2
  87. package/lib/SetSessionVariableQuery.js.map +1 -1
  88. package/lib/TCoordinate.d.ts +1 -1
  89. package/lib/Transaction.d.ts +24 -0
  90. package/lib/Transaction.js +82 -0
  91. package/lib/Transaction.js.map +1 -0
  92. package/lib/api.d.ts +2 -0
  93. package/lib/api.js +4 -2
  94. package/lib/api.js.map +1 -1
  95. package/package.json +22 -22
  96. package/src/DatabaseConnection.ts +4 -4
  97. package/src/Handler.ts +0 -4
  98. package/src/IDatabaseConnection.ts +3 -3
  99. package/src/IQueryable.ts +25 -0
  100. package/src/MySQLConnection.ts +15 -4
  101. package/src/Query.ts +3 -2
  102. package/src/ServiceResponse.ts +5 -0
  103. package/src/SetSessionVariableQuery.ts +2 -2
  104. package/src/Transaction.ts +97 -0
  105. package/src/api.ts +2 -0
@@ -41,7 +41,7 @@
41
41
 
42
42
  #### Defined in
43
43
 
44
- [src/MySQLDatabase.ts:27](https://github.com/breautek/storm/blob/4b2254f/src/MySQLDatabase.ts#L27)
44
+ [src/MySQLDatabase.ts:27](https://github.com/breautek/storm/blob/3748147/src/MySQLDatabase.ts#L27)
45
45
 
46
46
  ## Methods
47
47
 
@@ -66,7 +66,7 @@
66
66
 
67
67
  #### Defined in
68
68
 
69
- [src/MySQLDatabase.ts:49](https://github.com/breautek/storm/blob/4b2254f/src/MySQLDatabase.ts#L49)
69
+ [src/MySQLDatabase.ts:49](https://github.com/breautek/storm/blob/3748147/src/MySQLDatabase.ts#L49)
70
70
 
71
71
  ___
72
72
 
@@ -84,7 +84,7 @@ ___
84
84
 
85
85
  #### Defined in
86
86
 
87
- [src/MySQLDatabase.ts:59](https://github.com/breautek/storm/blob/4b2254f/src/MySQLDatabase.ts#L59)
87
+ [src/MySQLDatabase.ts:59](https://github.com/breautek/storm/blob/3748147/src/MySQLDatabase.ts#L59)
88
88
 
89
89
  ___
90
90
 
@@ -109,7 +109,7 @@ ___
109
109
 
110
110
  #### Defined in
111
111
 
112
- [src/MySQLDatabase.ts:72](https://github.com/breautek/storm/blob/4b2254f/src/MySQLDatabase.ts#L72)
112
+ [src/MySQLDatabase.ts:72](https://github.com/breautek/storm/blob/3748147/src/MySQLDatabase.ts#L72)
113
113
 
114
114
  ___
115
115
 
@@ -133,7 +133,7 @@ ___
133
133
 
134
134
  #### Defined in
135
135
 
136
- [src/MySQLDatabase.ts:54](https://github.com/breautek/storm/blob/4b2254f/src/MySQLDatabase.ts#L54)
136
+ [src/MySQLDatabase.ts:54](https://github.com/breautek/storm/blob/3748147/src/MySQLDatabase.ts#L54)
137
137
 
138
138
  ___
139
139
 
@@ -157,7 +157,7 @@ ___
157
157
 
158
158
  #### Defined in
159
159
 
160
- [src/Database.ts:31](https://github.com/breautek/storm/blob/4b2254f/src/Database.ts#L31)
160
+ [src/Database.ts:31](https://github.com/breautek/storm/blob/3748147/src/Database.ts#L31)
161
161
 
162
162
  ___
163
163
 
@@ -182,7 +182,7 @@ ___
182
182
 
183
183
  #### Defined in
184
184
 
185
- [src/Database.ts:45](https://github.com/breautek/storm/blob/4b2254f/src/Database.ts#L45)
185
+ [src/Database.ts:45](https://github.com/breautek/storm/blob/3748147/src/Database.ts#L45)
186
186
 
187
187
  ___
188
188
 
@@ -200,7 +200,7 @@ ___
200
200
 
201
201
  #### Defined in
202
202
 
203
- [src/Database.ts:77](https://github.com/breautek/storm/blob/4b2254f/src/Database.ts#L77)
203
+ [src/Database.ts:77](https://github.com/breautek/storm/blob/3748147/src/Database.ts#L77)
204
204
 
205
205
  ___
206
206
 
@@ -224,7 +224,7 @@ ___
224
224
 
225
225
  #### Defined in
226
226
 
227
- [src/MySQLDatabase.ts:40](https://github.com/breautek/storm/blob/4b2254f/src/MySQLDatabase.ts#L40)
227
+ [src/MySQLDatabase.ts:40](https://github.com/breautek/storm/blob/3748147/src/MySQLDatabase.ts#L40)
228
228
 
229
229
  ___
230
230
 
@@ -249,7 +249,7 @@ ___
249
249
 
250
250
  #### Defined in
251
251
 
252
- [src/Database.ts:64](https://github.com/breautek/storm/blob/4b2254f/src/Database.ts#L64)
252
+ [src/Database.ts:64](https://github.com/breautek/storm/blob/3748147/src/Database.ts#L64)
253
253
 
254
254
  ___
255
255
 
@@ -267,7 +267,7 @@ ___
267
267
 
268
268
  #### Defined in
269
269
 
270
- [src/Database.ts:40](https://github.com/breautek/storm/blob/4b2254f/src/Database.ts#L40)
270
+ [src/Database.ts:40](https://github.com/breautek/storm/blob/3748147/src/Database.ts#L40)
271
271
 
272
272
  ___
273
273
 
@@ -291,7 +291,7 @@ ___
291
291
 
292
292
  #### Defined in
293
293
 
294
- [src/Database.ts:54](https://github.com/breautek/storm/blob/4b2254f/src/Database.ts#L54)
294
+ [src/Database.ts:54](https://github.com/breautek/storm/blob/3748147/src/Database.ts#L54)
295
295
 
296
296
  ___
297
297
 
@@ -311,4 +311,4 @@ ___
311
311
 
312
312
  #### Defined in
313
313
 
314
- [src/MySQLDatabase.ts:45](https://github.com/breautek/storm/blob/4b2254f/src/MySQLDatabase.ts#L45)
314
+ [src/MySQLDatabase.ts:45](https://github.com/breautek/storm/blob/3748147/src/MySQLDatabase.ts#L45)
@@ -53,7 +53,7 @@
53
53
 
54
54
  #### Defined in
55
55
 
56
- [src/NotImplementedError.ts:27](https://github.com/breautek/storm/blob/4b2254f/src/NotImplementedError.ts#L27)
56
+ [src/NotImplementedError.ts:27](https://github.com/breautek/storm/blob/3748147/src/NotImplementedError.ts#L27)
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:1041
70
+ node_modules/typescript/lib/lib.es5.d.ts:1054
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:1040
84
+ node_modules/typescript/lib/lib.es5.d.ts:1053
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:1042
98
+ node_modules/typescript/lib/lib.es5.d.ts:1055
99
99
 
100
100
  ___
101
101
 
@@ -130,7 +130,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
130
130
 
131
131
  #### Defined in
132
132
 
133
- node_modules/@types/node/ts4.8/globals.d.ts:11
133
+ node_modules/@types/node/globals.d.ts:11
134
134
 
135
135
  ___
136
136
 
@@ -144,7 +144,7 @@ ___
144
144
 
145
145
  #### Defined in
146
146
 
147
- node_modules/@types/node/ts4.8/globals.d.ts:13
147
+ node_modules/@types/node/globals.d.ts:13
148
148
 
149
149
  ## Methods
150
150
 
@@ -162,7 +162,7 @@ node_modules/@types/node/ts4.8/globals.d.ts:13
162
162
 
163
163
  #### Defined in
164
164
 
165
- [src/NotImplementedError.ts:38](https://github.com/breautek/storm/blob/4b2254f/src/NotImplementedError.ts#L38)
165
+ [src/NotImplementedError.ts:38](https://github.com/breautek/storm/blob/3748147/src/NotImplementedError.ts#L38)
166
166
 
167
167
  ___
168
168
 
@@ -180,7 +180,7 @@ ___
180
180
 
181
181
  #### Defined in
182
182
 
183
- [src/StormError.ts:76](https://github.com/breautek/storm/blob/4b2254f/src/StormError.ts#L76)
183
+ [src/StormError.ts:76](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L76)
184
184
 
185
185
  ___
186
186
 
@@ -198,7 +198,7 @@ ___
198
198
 
199
199
  #### Defined in
200
200
 
201
- [src/StormError.ts:97](https://github.com/breautek/storm/blob/4b2254f/src/StormError.ts#L97)
201
+ [src/StormError.ts:97](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L97)
202
202
 
203
203
  ___
204
204
 
@@ -216,7 +216,7 @@ ___
216
216
 
217
217
  #### Defined in
218
218
 
219
- [src/NotImplementedError.ts:42](https://github.com/breautek/storm/blob/4b2254f/src/NotImplementedError.ts#L42)
219
+ [src/NotImplementedError.ts:42](https://github.com/breautek/storm/blob/3748147/src/NotImplementedError.ts#L42)
220
220
 
221
221
  ___
222
222
 
@@ -234,7 +234,7 @@ ___
234
234
 
235
235
  #### Defined in
236
236
 
237
- [src/NotImplementedError.ts:46](https://github.com/breautek/storm/blob/4b2254f/src/NotImplementedError.ts#L46)
237
+ [src/NotImplementedError.ts:46](https://github.com/breautek/storm/blob/3748147/src/NotImplementedError.ts#L46)
238
238
 
239
239
  ___
240
240
 
@@ -252,7 +252,7 @@ ___
252
252
 
253
253
  #### Defined in
254
254
 
255
- [src/NotImplementedError.ts:50](https://github.com/breautek/storm/blob/4b2254f/src/NotImplementedError.ts#L50)
255
+ [src/NotImplementedError.ts:50](https://github.com/breautek/storm/blob/3748147/src/NotImplementedError.ts#L50)
256
256
 
257
257
  ___
258
258
 
@@ -270,7 +270,7 @@ ___
270
270
 
271
271
  #### Defined in
272
272
 
273
- [src/NotImplementedError.ts:33](https://github.com/breautek/storm/blob/4b2254f/src/NotImplementedError.ts#L33)
273
+ [src/NotImplementedError.ts:33](https://github.com/breautek/storm/blob/3748147/src/NotImplementedError.ts#L33)
274
274
 
275
275
  ___
276
276
 
@@ -291,7 +291,7 @@ They are kept secret from the client.
291
291
 
292
292
  #### Defined in
293
293
 
294
- [src/StormError.ts:68](https://github.com/breautek/storm/blob/4b2254f/src/StormError.ts#L68)
294
+ [src/StormError.ts:68](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L68)
295
295
 
296
296
  ___
297
297
 
@@ -311,7 +311,7 @@ Sends details to the client.
311
311
 
312
312
  #### Defined in
313
313
 
314
- [src/StormError.ts:60](https://github.com/breautek/storm/blob/4b2254f/src/StormError.ts#L60)
314
+ [src/StormError.ts:60](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L60)
315
315
 
316
316
  ___
317
317
 
@@ -338,4 +338,4 @@ Create .stack property on a target object
338
338
 
339
339
  #### Defined in
340
340
 
341
- node_modules/@types/node/ts4.8/globals.d.ts:4
341
+ node_modules/@types/node/globals.d.ts:4
@@ -39,7 +39,7 @@
39
39
 
40
40
  #### Defined in
41
41
 
42
- [src/Point.ts:23](https://github.com/breautek/storm/blob/4b2254f/src/Point.ts#L23)
42
+ [src/Point.ts:23](https://github.com/breautek/storm/blob/3748147/src/Point.ts#L23)
43
43
 
44
44
  ## Methods
45
45
 
@@ -57,7 +57,7 @@
57
57
 
58
58
  #### Defined in
59
59
 
60
- [src/Point.ts:30](https://github.com/breautek/storm/blob/4b2254f/src/Point.ts#L30)
60
+ [src/Point.ts:30](https://github.com/breautek/storm/blob/3748147/src/Point.ts#L30)
61
61
 
62
62
  ___
63
63
 
@@ -81,7 +81,7 @@ ___
81
81
 
82
82
  #### Defined in
83
83
 
84
- [src/DatabaseCastObject.ts:24](https://github.com/breautek/storm/blob/4b2254f/src/DatabaseCastObject.ts#L24)
84
+ [src/DatabaseCastObject.ts:24](https://github.com/breautek/storm/blob/3748147/src/DatabaseCastObject.ts#L24)
85
85
 
86
86
  ___
87
87
 
@@ -99,4 +99,4 @@ ___
99
99
 
100
100
  #### Defined in
101
101
 
102
- [src/DatabaseCastObject.ts:20](https://github.com/breautek/storm/blob/4b2254f/src/DatabaseCastObject.ts#L20)
102
+ [src/DatabaseCastObject.ts:20](https://github.com/breautek/storm/blob/3748147/src/DatabaseCastObject.ts#L20)
@@ -38,7 +38,7 @@
38
38
 
39
39
  #### Defined in
40
40
 
41
- [src/Polygon.ts:23](https://github.com/breautek/storm/blob/4b2254f/src/Polygon.ts#L23)
41
+ [src/Polygon.ts:23](https://github.com/breautek/storm/blob/3748147/src/Polygon.ts#L23)
42
42
 
43
43
  ## Methods
44
44
 
@@ -56,7 +56,7 @@
56
56
 
57
57
  #### Defined in
58
58
 
59
- [src/Polygon.ts:29](https://github.com/breautek/storm/blob/4b2254f/src/Polygon.ts#L29)
59
+ [src/Polygon.ts:29](https://github.com/breautek/storm/blob/3748147/src/Polygon.ts#L29)
60
60
 
61
61
  ___
62
62
 
@@ -80,7 +80,7 @@ ___
80
80
 
81
81
  #### Defined in
82
82
 
83
- [src/DatabaseCastObject.ts:24](https://github.com/breautek/storm/blob/4b2254f/src/DatabaseCastObject.ts#L24)
83
+ [src/DatabaseCastObject.ts:24](https://github.com/breautek/storm/blob/3748147/src/DatabaseCastObject.ts#L24)
84
84
 
85
85
  ___
86
86
 
@@ -98,4 +98,4 @@ ___
98
98
 
99
99
  #### Defined in
100
100
 
101
- [src/DatabaseCastObject.ts:20](https://github.com/breautek/storm/blob/4b2254f/src/DatabaseCastObject.ts#L20)
101
+ [src/DatabaseCastObject.ts:20](https://github.com/breautek/storm/blob/3748147/src/DatabaseCastObject.ts#L20)
@@ -22,6 +22,10 @@
22
22
 
23
23
  ↳ [`SetSessionVariableQuery`](SetSessionVariableQuery.md)
24
24
 
25
+ ## Implements
26
+
27
+ - [`IQueryable`](../interfaces/IQueryable.md)<`TQueryPostProcessedResultSet`\>
28
+
25
29
  ## Table of contents
26
30
 
27
31
  ### Constructors
@@ -60,7 +64,7 @@
60
64
 
61
65
  #### Defined in
62
66
 
63
- [src/Query.ts:22](https://github.com/breautek/storm/blob/4b2254f/src/Query.ts#L22)
67
+ [src/Query.ts:23](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L23)
64
68
 
65
69
  ## Methods
66
70
 
@@ -80,7 +84,7 @@
80
84
 
81
85
  #### Defined in
82
86
 
83
- [src/Query.ts:42](https://github.com/breautek/storm/blob/4b2254f/src/Query.ts#L42)
87
+ [src/Query.ts:43](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L43)
84
88
 
85
89
  ___
86
90
 
@@ -98,9 +102,13 @@ ___
98
102
 
99
103
  `Promise`<`TQueryPostProcessedResultSet`\>
100
104
 
105
+ #### Implementation of
106
+
107
+ [IQueryable](../interfaces/IQueryable.md).[execute](../interfaces/IQueryable.md#execute)
108
+
101
109
  #### Defined in
102
110
 
103
- [src/Query.ts:70](https://github.com/breautek/storm/blob/4b2254f/src/Query.ts#L70)
111
+ [src/Query.ts:71](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L71)
104
112
 
105
113
  ___
106
114
 
@@ -116,25 +124,29 @@ parameters that was passed into the constructor.
116
124
 
117
125
  #### Defined in
118
126
 
119
- [src/Query.ts:29](https://github.com/breautek/storm/blob/4b2254f/src/Query.ts#L29)
127
+ [src/Query.ts:30](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L30)
120
128
 
121
129
  ___
122
130
 
123
131
  ### getParametersForQuery
124
132
 
125
- ▸ **getParametersForQuery**(): `Record`<`any`, `any`\>
133
+ ▸ **getParametersForQuery**(): `Record`<`string`, `any`\>
126
134
 
127
135
  Query implementations may override this API to augment the parameters.
128
136
 
129
137
  #### Returns
130
138
 
131
- `Record`<`any`, `any`\>
139
+ `Record`<`string`, `any`\>
132
140
 
133
141
  parameters that will be used when this query is ran.
134
142
 
143
+ #### Implementation of
144
+
145
+ [IQueryable](../interfaces/IQueryable.md).[getParametersForQuery](../interfaces/IQueryable.md#getparametersforquery)
146
+
135
147
  #### Defined in
136
148
 
137
- [src/Query.ts:38](https://github.com/breautek/storm/blob/4b2254f/src/Query.ts#L38)
149
+ [src/Query.ts:39](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L39)
138
150
 
139
151
  ___
140
152
 
@@ -152,9 +164,13 @@ ___
152
164
 
153
165
  `string`
154
166
 
167
+ #### Implementation of
168
+
169
+ [IQueryable](../interfaces/IQueryable.md).[getQuery](../interfaces/IQueryable.md#getquery)
170
+
155
171
  #### Defined in
156
172
 
157
- [src/Query.ts:44](https://github.com/breautek/storm/blob/4b2254f/src/Query.ts#L44)
173
+ [src/Query.ts:45](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L45)
158
174
 
159
175
  ___
160
176
 
@@ -175,9 +191,13 @@ Override to augment/manipulate the returned result set.
175
191
 
176
192
  `Promise`<`TQueryPostProcessedResultSet`\>
177
193
 
194
+ #### Implementation of
195
+
196
+ [IQueryable](../interfaces/IQueryable.md).[onPostProcess](../interfaces/IQueryable.md#onpostprocess)
197
+
178
198
  #### Defined in
179
199
 
180
- [src/Query.ts:65](https://github.com/breautek/storm/blob/4b2254f/src/Query.ts#L65)
200
+ [src/Query.ts:66](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L66)
181
201
 
182
202
  ___
183
203
 
@@ -198,6 +218,10 @@ Can be used to set session variables or create temporary tables, etc.
198
218
 
199
219
  `Promise`<`void`\>
200
220
 
221
+ #### Implementation of
222
+
223
+ [IQueryable](../interfaces/IQueryable.md).[onPreQuery](../interfaces/IQueryable.md#onprequery)
224
+
201
225
  #### Defined in
202
226
 
203
- [src/Query.ts:55](https://github.com/breautek/storm/blob/4b2254f/src/Query.ts#L55)
227
+ [src/Query.ts:56](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L56)
@@ -58,7 +58,7 @@ tag name.
58
58
 
59
59
  #### Defined in
60
60
 
61
- [src/RawError.ts:25](https://github.com/breautek/storm/blob/4b2254f/src/RawError.ts#L25)
61
+ [src/RawError.ts:25](https://github.com/breautek/storm/blob/3748147/src/RawError.ts#L25)
62
62
 
63
63
  ## Properties
64
64
 
@@ -72,7 +72,7 @@ tag name.
72
72
 
73
73
  #### Defined in
74
74
 
75
- node_modules/typescript/lib/lib.es5.d.ts:1041
75
+ node_modules/typescript/lib/lib.es5.d.ts:1054
76
76
 
77
77
  ___
78
78
 
@@ -86,7 +86,7 @@ ___
86
86
 
87
87
  #### Defined in
88
88
 
89
- node_modules/typescript/lib/lib.es5.d.ts:1040
89
+ node_modules/typescript/lib/lib.es5.d.ts:1053
90
90
 
91
91
  ___
92
92
 
@@ -100,7 +100,7 @@ ___
100
100
 
101
101
  #### Defined in
102
102
 
103
- node_modules/typescript/lib/lib.es5.d.ts:1042
103
+ node_modules/typescript/lib/lib.es5.d.ts:1055
104
104
 
105
105
  ___
106
106
 
@@ -135,7 +135,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
135
135
 
136
136
  #### Defined in
137
137
 
138
- node_modules/@types/node/ts4.8/globals.d.ts:11
138
+ node_modules/@types/node/globals.d.ts:11
139
139
 
140
140
  ___
141
141
 
@@ -149,7 +149,7 @@ ___
149
149
 
150
150
  #### Defined in
151
151
 
152
- node_modules/@types/node/ts4.8/globals.d.ts:13
152
+ node_modules/@types/node/globals.d.ts:13
153
153
 
154
154
  ## Methods
155
155
 
@@ -167,7 +167,7 @@ node_modules/@types/node/ts4.8/globals.d.ts:13
167
167
 
168
168
  #### Defined in
169
169
 
170
- [src/RawError.ts:32](https://github.com/breautek/storm/blob/4b2254f/src/RawError.ts#L32)
170
+ [src/RawError.ts:32](https://github.com/breautek/storm/blob/3748147/src/RawError.ts#L32)
171
171
 
172
172
  ___
173
173
 
@@ -185,7 +185,7 @@ ___
185
185
 
186
186
  #### Defined in
187
187
 
188
- [src/StormError.ts:76](https://github.com/breautek/storm/blob/4b2254f/src/StormError.ts#L76)
188
+ [src/StormError.ts:76](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L76)
189
189
 
190
190
  ___
191
191
 
@@ -203,7 +203,7 @@ ___
203
203
 
204
204
  #### Defined in
205
205
 
206
- [src/StormError.ts:97](https://github.com/breautek/storm/blob/4b2254f/src/StormError.ts#L97)
206
+ [src/StormError.ts:97](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L97)
207
207
 
208
208
  ___
209
209
 
@@ -221,7 +221,7 @@ ___
221
221
 
222
222
  #### Defined in
223
223
 
224
- [src/StormError.ts:72](https://github.com/breautek/storm/blob/4b2254f/src/StormError.ts#L72)
224
+ [src/StormError.ts:72](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L72)
225
225
 
226
226
  ___
227
227
 
@@ -239,7 +239,7 @@ ___
239
239
 
240
240
  #### Defined in
241
241
 
242
- [src/StormError.ts:89](https://github.com/breautek/storm/blob/4b2254f/src/StormError.ts#L89)
242
+ [src/StormError.ts:89](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L89)
243
243
 
244
244
  ___
245
245
 
@@ -257,7 +257,7 @@ ___
257
257
 
258
258
  #### Defined in
259
259
 
260
- [src/StormError.ts:93](https://github.com/breautek/storm/blob/4b2254f/src/StormError.ts#L93)
260
+ [src/StormError.ts:93](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L93)
261
261
 
262
262
  ___
263
263
 
@@ -275,7 +275,7 @@ ___
275
275
 
276
276
  #### Defined in
277
277
 
278
- [src/RawError.ts:36](https://github.com/breautek/storm/blob/4b2254f/src/RawError.ts#L36)
278
+ [src/RawError.ts:36](https://github.com/breautek/storm/blob/3748147/src/RawError.ts#L36)
279
279
 
280
280
  ___
281
281
 
@@ -301,7 +301,7 @@ They are kept secret from the client.
301
301
 
302
302
  #### Defined in
303
303
 
304
- [src/StormError.ts:68](https://github.com/breautek/storm/blob/4b2254f/src/StormError.ts#L68)
304
+ [src/StormError.ts:68](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L68)
305
305
 
306
306
  ___
307
307
 
@@ -321,7 +321,7 @@ Sends details to the client.
321
321
 
322
322
  #### Defined in
323
323
 
324
- [src/StormError.ts:60](https://github.com/breautek/storm/blob/4b2254f/src/StormError.ts#L60)
324
+ [src/StormError.ts:60](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L60)
325
325
 
326
326
  ___
327
327
 
@@ -348,4 +348,4 @@ Create .stack property on a target object
348
348
 
349
349
  #### Defined in
350
350
 
351
- node_modules/@types/node/ts4.8/globals.d.ts:4
351
+ node_modules/@types/node/globals.d.ts:4
@@ -59,7 +59,7 @@
59
59
 
60
60
  #### Defined in
61
61
 
62
- [src/RawQuery.ts:22](https://github.com/breautek/storm/blob/4b2254f/src/RawQuery.ts#L22)
62
+ [src/RawQuery.ts:22](https://github.com/breautek/storm/blob/3748147/src/RawQuery.ts#L22)
63
63
 
64
64
  ## Methods
65
65
 
@@ -77,7 +77,7 @@
77
77
 
78
78
  #### Defined in
79
79
 
80
- [src/RawQuery.ts:27](https://github.com/breautek/storm/blob/4b2254f/src/RawQuery.ts#L27)
80
+ [src/RawQuery.ts:27](https://github.com/breautek/storm/blob/3748147/src/RawQuery.ts#L27)
81
81
 
82
82
  ___
83
83
 
@@ -101,7 +101,7 @@ ___
101
101
 
102
102
  #### Defined in
103
103
 
104
- [src/Query.ts:70](https://github.com/breautek/storm/blob/4b2254f/src/Query.ts#L70)
104
+ [src/Query.ts:71](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L71)
105
105
 
106
106
  ___
107
107
 
@@ -121,19 +121,19 @@ parameters that was passed into the constructor.
121
121
 
122
122
  #### Defined in
123
123
 
124
- [src/Query.ts:29](https://github.com/breautek/storm/blob/4b2254f/src/Query.ts#L29)
124
+ [src/Query.ts:30](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L30)
125
125
 
126
126
  ___
127
127
 
128
128
  ### getParametersForQuery
129
129
 
130
- ▸ **getParametersForQuery**(): `Record`<`any`, `any`\>
130
+ ▸ **getParametersForQuery**(): `Record`<`string`, `any`\>
131
131
 
132
132
  Query implementations may override this API to augment the parameters.
133
133
 
134
134
  #### Returns
135
135
 
136
- `Record`<`any`, `any`\>
136
+ `Record`<`string`, `any`\>
137
137
 
138
138
  parameters that will be used when this query is ran.
139
139
 
@@ -143,7 +143,7 @@ parameters that will be used when this query is ran.
143
143
 
144
144
  #### Defined in
145
145
 
146
- [src/Query.ts:38](https://github.com/breautek/storm/blob/4b2254f/src/Query.ts#L38)
146
+ [src/Query.ts:39](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L39)
147
147
 
148
148
  ___
149
149
 
@@ -167,7 +167,7 @@ ___
167
167
 
168
168
  #### Defined in
169
169
 
170
- [src/Query.ts:44](https://github.com/breautek/storm/blob/4b2254f/src/Query.ts#L44)
170
+ [src/Query.ts:45](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L45)
171
171
 
172
172
  ___
173
173
 
@@ -194,7 +194,7 @@ Override to augment/manipulate the returned result set.
194
194
 
195
195
  #### Defined in
196
196
 
197
- [src/Query.ts:65](https://github.com/breautek/storm/blob/4b2254f/src/Query.ts#L65)
197
+ [src/Query.ts:66](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L66)
198
198
 
199
199
  ___
200
200
 
@@ -221,4 +221,4 @@ Can be used to set session variables or create temporary tables, etc.
221
221
 
222
222
  #### Defined in
223
223
 
224
- [src/Query.ts:55](https://github.com/breautek/storm/blob/4b2254f/src/Query.ts#L55)
224
+ [src/Query.ts:56](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L56)