@breautek/storm 4.6.3 → 5.0.1-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. package/.eslintrc.js +6 -4
  2. package/CHANGELOG.md +28 -0
  3. package/docs/README.md +8 -5
  4. package/docs/classes/Application.md +26 -26
  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/DatabaseCastObject.md +3 -3
  10. package/docs/classes/DatabaseConnection.md +21 -21
  11. package/docs/classes/DatabaseQueryError.md +12 -10
  12. package/docs/classes/DeadLockError.md +10 -10
  13. package/docs/classes/DiskSpaceError.md +10 -10
  14. package/docs/classes/DropTemporaryTableQuery.md +10 -10
  15. package/docs/classes/DumpStream.md +1 -1
  16. package/docs/classes/DuplicateEntryError.md +10 -10
  17. package/docs/classes/EntityNotFoundError.md +10 -10
  18. package/docs/classes/ExpiredTokenError.md +10 -10
  19. package/docs/classes/Handler.md +13 -34
  20. package/docs/classes/InternalError.md +10 -10
  21. package/docs/classes/InvalidCredentialsError.md +10 -10
  22. package/docs/classes/InvalidValueError.md +10 -10
  23. package/docs/classes/LineString.md +4 -4
  24. package/docs/classes/LockWaitTimeoutError.md +349 -0
  25. package/docs/classes/ManagedDatabaseConnection.md +19 -19
  26. package/docs/classes/Middleware.md +3 -3
  27. package/docs/classes/MissingConfigError.md +10 -10
  28. package/docs/classes/MissingParameterError.md +10 -10
  29. package/docs/classes/MySQLConnection.md +22 -22
  30. package/docs/classes/MySQLDatabase.md +13 -13
  31. package/docs/classes/NotImplementedError.md +10 -10
  32. package/docs/classes/Point.md +4 -4
  33. package/docs/classes/Polygon.md +4 -4
  34. package/docs/classes/Query.md +34 -10
  35. package/docs/classes/RawError.md +10 -10
  36. package/docs/classes/RawQuery.md +10 -10
  37. package/docs/classes/Request.md +18 -18
  38. package/docs/classes/Response.md +11 -11
  39. package/docs/classes/ResponseData.md +7 -7
  40. package/docs/classes/ServiceProvider.md +15 -15
  41. package/docs/classes/ServiceResponse.md +19 -4
  42. package/docs/classes/SetSessionVariableQuery.md +8 -8
  43. package/docs/classes/StormError.md +10 -10
  44. package/docs/classes/TemporaryTableQuery.md +8 -8
  45. package/docs/classes/Token.md +2 -2
  46. package/docs/classes/TokenManager.md +4 -4
  47. package/docs/classes/Transaction.md +161 -0
  48. package/docs/classes/UnauthorizedAccessError.md +10 -10
  49. package/docs/enums/ErrorCode.md +9 -9
  50. package/docs/enums/ExitCode.md +2 -2
  51. package/docs/enums/HTTPMethod.md +4 -4
  52. package/docs/enums/IsolationLevel.md +4 -4
  53. package/docs/enums/JWTError.md +2 -2
  54. package/docs/enums/StatusCode.md +48 -48
  55. package/docs/interfaces/IConfig.md +8 -8
  56. package/docs/interfaces/IDatabaseConfig.md +6 -6
  57. package/docs/interfaces/IDatabaseConnection.md +16 -16
  58. package/docs/interfaces/IErrorResponse.md +5 -5
  59. package/docs/interfaces/IFormData.md +2 -2
  60. package/docs/interfaces/IHandler.md +1 -1
  61. package/docs/interfaces/IInsertQueryResult.md +3 -3
  62. package/docs/interfaces/IJWTVerifyOptions.md +1 -1
  63. package/docs/interfaces/IQueryable.md +119 -0
  64. package/docs/interfaces/IRequestResponse.md +2 -2
  65. package/docs/interfaces/ISetSessionVariableQueryInput.md +2 -2
  66. package/docs/interfaces/ITemporaryTableQueryInput.md +2 -2
  67. package/docs/interfaces/IUpdateQueryResult.md +2 -2
  68. package/jest.config.js +9 -5
  69. package/lib/DatabaseConnection.d.ts +3 -3
  70. package/lib/DatabaseConnection.js.map +1 -1
  71. package/lib/Handler.d.ts +0 -1
  72. package/lib/Handler.js +0 -2
  73. package/lib/Handler.js.map +1 -1
  74. package/lib/IDatabaseConnection.d.ts +3 -3
  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/LockWaitTimeoutError.d.ts +6 -0
  79. package/lib/LockWaitTimeoutError.js +26 -0
  80. package/lib/LockWaitTimeoutError.js.map +1 -0
  81. package/lib/MySQLConnection.js +22 -4
  82. package/lib/MySQLConnection.js.map +1 -1
  83. package/lib/Query.d.ts +3 -2
  84. package/lib/Query.js.map +1 -1
  85. package/lib/ServiceResponse.d.ts +2 -0
  86. package/lib/ServiceResponse.js +3 -0
  87. package/lib/ServiceResponse.js.map +1 -1
  88. package/lib/SetSessionVariableQuery.js +2 -2
  89. package/lib/SetSessionVariableQuery.js.map +1 -1
  90. package/lib/Transaction.d.ts +24 -0
  91. package/lib/Transaction.js +88 -0
  92. package/lib/Transaction.js.map +1 -0
  93. package/lib/api.d.ts +3 -0
  94. package/lib/api.js +6 -2
  95. package/lib/api.js.map +1 -1
  96. package/package.json +11 -12
  97. package/src/DatabaseConnection.ts +4 -4
  98. package/src/Handler.ts +0 -4
  99. package/src/IDatabaseConnection.ts +3 -3
  100. package/src/IQueryable.ts +25 -0
  101. package/src/LockWaitTimeoutError.ts +22 -0
  102. package/src/MySQLConnection.ts +22 -4
  103. package/src/Query.ts +3 -2
  104. package/src/ServiceResponse.ts +5 -0
  105. package/src/SetSessionVariableQuery.ts +2 -2
  106. package/src/Transaction.ts +103 -0
  107. package/src/api.ts +3 -0
package/docs/classes/MissingParameterError.md CHANGED
@@ -53,7 +53,7 @@
53
53
 
54
54
  #### Defined in
55
55
 
56
- [src/MissingParameterError.ts:22](https://github.com/breautek/storm/blob/5fbba2d/src/MissingParameterError.ts#L22)
56
+ [src/MissingParameterError.ts:22](https://github.com/breautek/storm/blob/d45307d/src/MissingParameterError.ts#L22)
57
57
 
58
58
  ## Properties
59
59
 
@@ -162,7 +162,7 @@ node_modules/@types/node/globals.d.ts:13
162
162
 
163
163
  #### Defined in
164
164
 
165
- [src/MissingParameterError.ts:30](https://github.com/breautek/storm/blob/5fbba2d/src/MissingParameterError.ts#L30)
165
+ [src/MissingParameterError.ts:30](https://github.com/breautek/storm/blob/d45307d/src/MissingParameterError.ts#L30)
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/5fbba2d/src/StormError.ts#L76)
183
+ [src/StormError.ts:76](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/StormError.ts#L97)
201
+ [src/StormError.ts:97](https://github.com/breautek/storm/blob/d45307d/src/StormError.ts#L97)
202
202
 
203
203
  ___
204
204
 
@@ -216,7 +216,7 @@ ___
216
216
 
217
217
  #### Defined in
218
218
 
219
- [src/MissingParameterError.ts:34](https://github.com/breautek/storm/blob/5fbba2d/src/MissingParameterError.ts#L34)
219
+ [src/MissingParameterError.ts:34](https://github.com/breautek/storm/blob/d45307d/src/MissingParameterError.ts#L34)
220
220
 
221
221
  ___
222
222
 
@@ -234,7 +234,7 @@ ___
234
234
 
235
235
  #### Defined in
236
236
 
237
- [src/MissingParameterError.ts:38](https://github.com/breautek/storm/blob/5fbba2d/src/MissingParameterError.ts#L38)
237
+ [src/MissingParameterError.ts:38](https://github.com/breautek/storm/blob/d45307d/src/MissingParameterError.ts#L38)
238
238
 
239
239
  ___
240
240
 
@@ -252,7 +252,7 @@ ___
252
252
 
253
253
  #### Defined in
254
254
 
255
- [src/MissingParameterError.ts:42](https://github.com/breautek/storm/blob/5fbba2d/src/MissingParameterError.ts#L42)
255
+ [src/MissingParameterError.ts:42](https://github.com/breautek/storm/blob/d45307d/src/MissingParameterError.ts#L42)
256
256
 
257
257
  ___
258
258
 
@@ -270,7 +270,7 @@ ___
270
270
 
271
271
  #### Defined in
272
272
 
273
- [src/MissingParameterError.ts:26](https://github.com/breautek/storm/blob/5fbba2d/src/MissingParameterError.ts#L26)
273
+ [src/MissingParameterError.ts:26](https://github.com/breautek/storm/blob/d45307d/src/MissingParameterError.ts#L26)
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/5fbba2d/src/StormError.ts#L68)
294
+ [src/StormError.ts:68](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/StormError.ts#L60)
314
+ [src/StormError.ts:60](https://github.com/breautek/storm/blob/d45307d/src/StormError.ts#L60)
315
315
 
316
316
  ___
317
317
 
package/docs/classes/MySQLConnection.md CHANGED
@@ -64,7 +64,7 @@ Do not call `new Database` directly. Use `Database.getConnection` to create a `D
64
64
 
65
65
  #### Defined in
66
66
 
67
- [src/MySQLConnection.ts:50](https://github.com/breautek/storm/blob/5fbba2d/src/MySQLConnection.ts#L50)
67
+ [src/MySQLConnection.ts:59](https://github.com/breautek/storm/blob/d45307d/src/MySQLConnection.ts#L59)
68
68
 
69
69
  ## Methods
70
70
 
@@ -95,7 +95,7 @@ Promise<void>
95
95
 
96
96
  #### Defined in
97
97
 
98
- [src/MySQLConnection.ts:206](https://github.com/breautek/storm/blob/5fbba2d/src/MySQLConnection.ts#L206)
98
+ [src/MySQLConnection.ts:224](https://github.com/breautek/storm/blob/d45307d/src/MySQLConnection.ts#L224)
99
99
 
100
100
  ___
101
101
 
@@ -126,7 +126,7 @@ Promise
126
126
 
127
127
  #### Defined in
128
128
 
129
- [src/MySQLConnection.ts:78](https://github.com/breautek/storm/blob/5fbba2d/src/MySQLConnection.ts#L78)
129
+ [src/MySQLConnection.ts:87](https://github.com/breautek/storm/blob/d45307d/src/MySQLConnection.ts#L87)
130
130
 
131
131
  ___
132
132
 
@@ -157,7 +157,7 @@ but returns a `Readable` stream instead.
157
157
 
158
158
  #### Defined in
159
159
 
160
- [src/MySQLConnection.ts:127](https://github.com/breautek/storm/blob/5fbba2d/src/MySQLConnection.ts#L127)
160
+ [src/MySQLConnection.ts:145](https://github.com/breautek/storm/blob/d45307d/src/MySQLConnection.ts#L145)
161
161
 
162
162
  ___
163
163
 
@@ -189,7 +189,7 @@ Promise<void>
189
189
 
190
190
  #### Defined in
191
191
 
192
- [src/DatabaseConnection.ts:169](https://github.com/breautek/storm/blob/5fbba2d/src/DatabaseConnection.ts#L169)
192
+ [src/DatabaseConnection.ts:169](https://github.com/breautek/storm/blob/d45307d/src/DatabaseConnection.ts#L169)
193
193
 
194
194
  ___
195
195
 
@@ -215,7 +215,7 @@ Promise<void>
215
215
 
216
216
  #### Defined in
217
217
 
218
- [src/MySQLConnection.ts:190](https://github.com/breautek/storm/blob/5fbba2d/src/MySQLConnection.ts#L190)
218
+ [src/MySQLConnection.ts:208](https://github.com/breautek/storm/blob/d45307d/src/MySQLConnection.ts#L208)
219
219
 
220
220
  ___
221
221
 
@@ -247,7 +247,7 @@ Promise<void>
247
247
 
248
248
  #### Defined in
249
249
 
250
- [src/MySQLConnection.ts:170](https://github.com/breautek/storm/blob/5fbba2d/src/MySQLConnection.ts#L170)
250
+ [src/MySQLConnection.ts:188](https://github.com/breautek/storm/blob/d45307d/src/MySQLConnection.ts#L188)
251
251
 
252
252
  ___
253
253
 
@@ -269,7 +269,7 @@ any
269
269
 
270
270
  #### Defined in
271
271
 
272
- [src/DatabaseConnection.ts:91](https://github.com/breautek/storm/blob/5fbba2d/src/DatabaseConnection.ts#L91)
272
+ [src/DatabaseConnection.ts:91](https://github.com/breautek/storm/blob/d45307d/src/DatabaseConnection.ts#L91)
273
273
 
274
274
  ___
275
275
 
@@ -292,7 +292,7 @@ string - A stacktrace
292
292
 
293
293
  #### Defined in
294
294
 
295
- [src/DatabaseConnection.ts:73](https://github.com/breautek/storm/blob/5fbba2d/src/DatabaseConnection.ts#L73)
295
+ [src/DatabaseConnection.ts:73](https://github.com/breautek/storm/blob/d45307d/src/DatabaseConnection.ts#L73)
296
296
 
297
297
  ___
298
298
 
@@ -314,7 +314,7 @@ number in milliseconds
314
314
 
315
315
  #### Defined in
316
316
 
317
- [src/DatabaseConnection.ts:121](https://github.com/breautek/storm/blob/5fbba2d/src/DatabaseConnection.ts#L121)
317
+ [src/DatabaseConnection.ts:121](https://github.com/breautek/storm/blob/d45307d/src/DatabaseConnection.ts#L121)
318
318
 
319
319
  ___
320
320
 
@@ -334,7 +334,7 @@ Returns true if the connection has been closed.
334
334
 
335
335
  #### Defined in
336
336
 
337
- [src/DatabaseConnection.ts:182](https://github.com/breautek/storm/blob/5fbba2d/src/DatabaseConnection.ts#L182)
337
+ [src/DatabaseConnection.ts:182](https://github.com/breautek/storm/blob/d45307d/src/DatabaseConnection.ts#L182)
338
338
 
339
339
  ___
340
340
 
@@ -348,7 +348,7 @@ ___
348
348
 
349
349
  #### Defined in
350
350
 
351
- [src/MySQLConnection.ts:73](https://github.com/breautek/storm/blob/5fbba2d/src/MySQLConnection.ts#L73)
351
+ [src/MySQLConnection.ts:82](https://github.com/breautek/storm/blob/d45307d/src/MySQLConnection.ts#L82)
352
352
 
353
353
  ___
354
354
 
@@ -371,7 +371,7 @@ boolean
371
371
 
372
372
  #### Defined in
373
373
 
374
- [src/DatabaseConnection.ts:100](https://github.com/breautek/storm/blob/5fbba2d/src/DatabaseConnection.ts#L100)
374
+ [src/DatabaseConnection.ts:100](https://github.com/breautek/storm/blob/d45307d/src/DatabaseConnection.ts#L100)
375
375
 
376
376
  ___
377
377
 
@@ -395,7 +395,7 @@ boolean
395
395
 
396
396
  #### Defined in
397
397
 
398
- [src/MySQLConnection.ts:69](https://github.com/breautek/storm/blob/5fbba2d/src/MySQLConnection.ts#L69)
398
+ [src/MySQLConnection.ts:78](https://github.com/breautek/storm/blob/d45307d/src/MySQLConnection.ts#L78)
399
399
 
400
400
  ___
401
401
 
@@ -417,7 +417,7 @@ Queries the database for a dataset.
417
417
 
418
418
  | Name | Type | Description |
419
419
  | :------ | :------ | :------ |
420
- | `query` | [`Query`](Query.md)<`any`, `any`, `any`\> | The database query |
420
+ | `query` | [`IQueryable`](../interfaces/IQueryable.md)<`TQueryResult`\> | The database query |
421
421
 
422
422
  #### Returns
423
423
 
@@ -431,7 +431,7 @@ Promise<TQueryResult>
431
431
 
432
432
  #### Defined in
433
433
 
434
- [src/DatabaseConnection.ts:132](https://github.com/breautek/storm/blob/5fbba2d/src/DatabaseConnection.ts#L132)
434
+ [src/DatabaseConnection.ts:132](https://github.com/breautek/storm/blob/d45307d/src/DatabaseConnection.ts#L132)
435
435
 
436
436
  ___
437
437
 
@@ -457,7 +457,7 @@ Promise<void>
457
457
 
458
458
  #### Defined in
459
459
 
460
- [src/MySQLConnection.ts:174](https://github.com/breautek/storm/blob/5fbba2d/src/MySQLConnection.ts#L174)
460
+ [src/MySQLConnection.ts:192](https://github.com/breautek/storm/blob/d45307d/src/MySQLConnection.ts#L192)
461
461
 
462
462
  ___
463
463
 
@@ -481,7 +481,7 @@ ___
481
481
 
482
482
  #### Defined in
483
483
 
484
- [src/DatabaseConnection.ts:64](https://github.com/breautek/storm/blob/5fbba2d/src/DatabaseConnection.ts#L64)
484
+ [src/DatabaseConnection.ts:64](https://github.com/breautek/storm/blob/d45307d/src/DatabaseConnection.ts#L64)
485
485
 
486
486
  ___
487
487
 
@@ -507,7 +507,7 @@ Sets the timeout of this connectino
507
507
 
508
508
  #### Defined in
509
509
 
510
- [src/DatabaseConnection.ts:109](https://github.com/breautek/storm/blob/5fbba2d/src/DatabaseConnection.ts#L109)
510
+ [src/DatabaseConnection.ts:109](https://github.com/breautek/storm/blob/d45307d/src/DatabaseConnection.ts#L109)
511
511
 
512
512
  ___
513
513
 
@@ -539,7 +539,7 @@ Promise<void>
539
539
 
540
540
  #### Defined in
541
541
 
542
- [src/MySQLConnection.ts:146](https://github.com/breautek/storm/blob/5fbba2d/src/MySQLConnection.ts#L146)
542
+ [src/MySQLConnection.ts:164](https://github.com/breautek/storm/blob/d45307d/src/MySQLConnection.ts#L164)
543
543
 
544
544
  ___
545
545
 
@@ -551,7 +551,7 @@ ___
551
551
 
552
552
  | Name | Type | Description |
553
553
  | :------ | :------ | :------ |
554
- | `query` | [`Query`](Query.md)<`any`, `any`, `any`\> | The database query |
554
+ | `query` | [`IQueryable`](../interfaces/IQueryable.md)<`any`\> | The database query |
555
555
  | `streamOptions?` | `any` | Stream options |
556
556
 
557
557
  #### Returns
@@ -566,4 +566,4 @@ Readable
566
566
 
567
567
  #### Defined in
568
568
 
569
- [src/DatabaseConnection.ts:152](https://github.com/breautek/storm/blob/5fbba2d/src/DatabaseConnection.ts#L152)
569
+ [src/DatabaseConnection.ts:152](https://github.com/breautek/storm/blob/d45307d/src/DatabaseConnection.ts#L152)
package/docs/classes/MySQLDatabase.md CHANGED
@@ -41,7 +41,7 @@
41
41
 
42
42
  #### Defined in
43
43
 
44
- [src/MySQLDatabase.ts:27](https://github.com/breautek/storm/blob/5fbba2d/src/MySQLDatabase.ts#L27)
44
+ [src/MySQLDatabase.ts:27](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/MySQLDatabase.ts#L49)
69
+ [src/MySQLDatabase.ts:49](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/MySQLDatabase.ts#L59)
87
+ [src/MySQLDatabase.ts:59](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/MySQLDatabase.ts#L72)
112
+ [src/MySQLDatabase.ts:72](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/MySQLDatabase.ts#L54)
136
+ [src/MySQLDatabase.ts:54](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/Database.ts#L31)
160
+ [src/Database.ts:31](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/Database.ts#L45)
185
+ [src/Database.ts:45](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/Database.ts#L77)
203
+ [src/Database.ts:77](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/MySQLDatabase.ts#L40)
227
+ [src/MySQLDatabase.ts:40](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/Database.ts#L64)
252
+ [src/Database.ts:64](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/Database.ts#L40)
270
+ [src/Database.ts:40](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/Database.ts#L54)
294
+ [src/Database.ts:54](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/MySQLDatabase.ts#L45)
314
+ [src/MySQLDatabase.ts:45](https://github.com/breautek/storm/blob/d45307d/src/MySQLDatabase.ts#L45)
package/docs/classes/NotImplementedError.md CHANGED
@@ -53,7 +53,7 @@
53
53
 
54
54
  #### Defined in
55
55
 
56
- [src/NotImplementedError.ts:27](https://github.com/breautek/storm/blob/5fbba2d/src/NotImplementedError.ts#L27)
56
+ [src/NotImplementedError.ts:27](https://github.com/breautek/storm/blob/d45307d/src/NotImplementedError.ts#L27)
57
57
 
58
58
  ## Properties
59
59
 
@@ -162,7 +162,7 @@ node_modules/@types/node/globals.d.ts:13
162
162
 
163
163
  #### Defined in
164
164
 
165
- [src/NotImplementedError.ts:38](https://github.com/breautek/storm/blob/5fbba2d/src/NotImplementedError.ts#L38)
165
+ [src/NotImplementedError.ts:38](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/StormError.ts#L76)
183
+ [src/StormError.ts:76](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/StormError.ts#L97)
201
+ [src/StormError.ts:97](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/NotImplementedError.ts#L42)
219
+ [src/NotImplementedError.ts:42](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/NotImplementedError.ts#L46)
237
+ [src/NotImplementedError.ts:46](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/NotImplementedError.ts#L50)
255
+ [src/NotImplementedError.ts:50](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/NotImplementedError.ts#L33)
273
+ [src/NotImplementedError.ts:33](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/StormError.ts#L68)
294
+ [src/StormError.ts:68](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/StormError.ts#L60)
314
+ [src/StormError.ts:60](https://github.com/breautek/storm/blob/d45307d/src/StormError.ts#L60)
315
315
 
316
316
  ___
317
317
 
package/docs/classes/Point.md CHANGED
@@ -39,7 +39,7 @@
39
39
 
40
40
  #### Defined in
41
41
 
42
- [src/Point.ts:23](https://github.com/breautek/storm/blob/5fbba2d/src/Point.ts#L23)
42
+ [src/Point.ts:23](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/Point.ts#L30)
60
+ [src/Point.ts:30](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/DatabaseCastObject.ts#L24)
84
+ [src/DatabaseCastObject.ts:24](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/DatabaseCastObject.ts#L20)
102
+ [src/DatabaseCastObject.ts:20](https://github.com/breautek/storm/blob/d45307d/src/DatabaseCastObject.ts#L20)
package/docs/classes/Polygon.md CHANGED
@@ -38,7 +38,7 @@
38
38
 
39
39
  #### Defined in
40
40
 
41
- [src/Polygon.ts:23](https://github.com/breautek/storm/blob/5fbba2d/src/Polygon.ts#L23)
41
+ [src/Polygon.ts:23](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/Polygon.ts#L29)
59
+ [src/Polygon.ts:29](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/DatabaseCastObject.ts#L24)
83
+ [src/DatabaseCastObject.ts:24](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/DatabaseCastObject.ts#L20)
101
+ [src/DatabaseCastObject.ts:20](https://github.com/breautek/storm/blob/d45307d/src/DatabaseCastObject.ts#L20)
package/docs/classes/Query.md CHANGED
@@ -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/5fbba2d/src/Query.ts#L22)
67
+ [src/Query.ts:23](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/Query.ts#L42)
87
+ [src/Query.ts:43](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/Query.ts#L70)
111
+ [src/Query.ts:71](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/Query.ts#L29)
127
+ [src/Query.ts:30](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/Query.ts#L38)
149
+ [src/Query.ts:39](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/Query.ts#L44)
173
+ [src/Query.ts:45](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/Query.ts#L65)
200
+ [src/Query.ts:66](https://github.com/breautek/storm/blob/d45307d/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/5fbba2d/src/Query.ts#L55)
227
+ [src/Query.ts:56](https://github.com/breautek/storm/blob/d45307d/src/Query.ts#L56)