@breautek/storm 4.6.3 → 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 (101) hide show
  1. package/CHANGELOG.md +31 -0
  2. package/docs/README.md +7 -5
  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/DatabaseCastObject.md +3 -3
  9. package/docs/classes/DatabaseConnection.md +21 -21
  10. package/docs/classes/DatabaseQueryError.md +10 -10
  11. package/docs/classes/DeadLockError.md +10 -10
  12. package/docs/classes/DiskSpaceError.md +10 -10
  13. package/docs/classes/DropTemporaryTableQuery.md +10 -10
  14. package/docs/classes/DumpStream.md +1 -1
  15. package/docs/classes/DuplicateEntryError.md +10 -10
  16. package/docs/classes/EntityNotFoundError.md +10 -10
  17. package/docs/classes/ExpiredTokenError.md +10 -10
  18. package/docs/classes/Handler.md +13 -34
  19. package/docs/classes/InternalError.md +10 -10
  20. package/docs/classes/InvalidCredentialsError.md +10 -10
  21. package/docs/classes/InvalidValueError.md +10 -10
  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 +10 -10
  26. package/docs/classes/MissingParameterError.md +10 -10
  27. package/docs/classes/MySQLConnection.md +22 -22
  28. package/docs/classes/MySQLDatabase.md +13 -13
  29. package/docs/classes/NotImplementedError.md +10 -10
  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 +10 -10
  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 +10 -10
  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 +10 -10
  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/jest.config.js +9 -5
  67. package/lib/DatabaseConnection.d.ts +3 -3
  68. package/lib/DatabaseConnection.js.map +1 -1
  69. package/lib/Handler.d.ts +0 -1
  70. package/lib/Handler.js +0 -2
  71. package/lib/Handler.js.map +1 -1
  72. package/lib/IDatabaseConnection.d.ts +3 -3
  73. package/lib/IQueryable.d.ts +8 -0
  74. package/lib/IQueryable.js +18 -0
  75. package/lib/IQueryable.js.map +1 -0
  76. package/lib/MySQLConnection.js +15 -4
  77. package/lib/MySQLConnection.js.map +1 -1
  78. package/lib/Query.d.ts +3 -2
  79. package/lib/Query.js.map +1 -1
  80. package/lib/ServiceResponse.d.ts +2 -0
  81. package/lib/ServiceResponse.js +3 -0
  82. package/lib/ServiceResponse.js.map +1 -1
  83. package/lib/SetSessionVariableQuery.js +2 -2
  84. package/lib/SetSessionVariableQuery.js.map +1 -1
  85. package/lib/Transaction.d.ts +24 -0
  86. package/lib/Transaction.js +82 -0
  87. package/lib/Transaction.js.map +1 -0
  88. package/lib/api.d.ts +2 -0
  89. package/lib/api.js +4 -2
  90. package/lib/api.js.map +1 -1
  91. package/package.json +12 -12
  92. package/src/DatabaseConnection.ts +4 -4
  93. package/src/Handler.ts +0 -4
  94. package/src/IDatabaseConnection.ts +3 -3
  95. package/src/IQueryable.ts +25 -0
  96. package/src/MySQLConnection.ts +15 -4
  97. package/src/Query.ts +3 -2
  98. package/src/ServiceResponse.ts +5 -0
  99. package/src/SetSessionVariableQuery.ts +2 -2
  100. package/src/Transaction.ts +97 -0
  101. package/src/api.ts +2 -0
package/docs/classes/ResponseData.md CHANGED
@@ -44,7 +44,7 @@
44
44
 
45
45
  #### Defined in
46
46
 
47
- [src/ResponseData.ts:25](https://github.com/breautek/storm/blob/5fbba2d/src/ResponseData.ts#L25)
47
+ [src/ResponseData.ts:25](https://github.com/breautek/storm/blob/3748147/src/ResponseData.ts#L25)
48
48
 
49
49
  ## Methods
50
50
 
@@ -58,7 +58,7 @@
58
58
 
59
59
  #### Defined in
60
60
 
61
- [src/ResponseData.ts:44](https://github.com/breautek/storm/blob/5fbba2d/src/ResponseData.ts#L44)
61
+ [src/ResponseData.ts:44](https://github.com/breautek/storm/blob/3748147/src/ResponseData.ts#L44)
62
62
 
63
63
  ___
64
64
 
@@ -72,7 +72,7 @@ ___
72
72
 
73
73
  #### Defined in
74
74
 
75
- [src/ResponseData.ts:36](https://github.com/breautek/storm/blob/5fbba2d/src/ResponseData.ts#L36)
75
+ [src/ResponseData.ts:36](https://github.com/breautek/storm/blob/3748147/src/ResponseData.ts#L36)
76
76
 
77
77
  ___
78
78
 
@@ -86,7 +86,7 @@ ___
86
86
 
87
87
  #### Defined in
88
88
 
89
- [src/ResponseData.ts:52](https://github.com/breautek/storm/blob/5fbba2d/src/ResponseData.ts#L52)
89
+ [src/ResponseData.ts:52](https://github.com/breautek/storm/blob/3748147/src/ResponseData.ts#L52)
90
90
 
91
91
  ___
92
92
 
@@ -100,7 +100,7 @@ ___
100
100
 
101
101
  #### Defined in
102
102
 
103
- [src/ResponseData.ts:40](https://github.com/breautek/storm/blob/5fbba2d/src/ResponseData.ts#L40)
103
+ [src/ResponseData.ts:40](https://github.com/breautek/storm/blob/3748147/src/ResponseData.ts#L40)
104
104
 
105
105
  ___
106
106
 
@@ -120,7 +120,7 @@ ___
120
120
 
121
121
  #### Defined in
122
122
 
123
- [src/ResponseData.ts:48](https://github.com/breautek/storm/blob/5fbba2d/src/ResponseData.ts#L48)
123
+ [src/ResponseData.ts:48](https://github.com/breautek/storm/blob/3748147/src/ResponseData.ts#L48)
124
124
 
125
125
  ___
126
126
 
@@ -141,4 +141,4 @@ ___
141
141
 
142
142
  #### Defined in
143
143
 
144
- [src/ResponseData.ts:32](https://github.com/breautek/storm/blob/5fbba2d/src/ResponseData.ts#L32)
144
+ [src/ResponseData.ts:32](https://github.com/breautek/storm/blob/3748147/src/ResponseData.ts#L32)
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/5fbba2d/src/ServiceProvider.ts#L29)
42
+ [src/ServiceProvider.ts:29](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/ServiceProvider.ts#L64)
63
+ [src/ServiceProvider.ts:64](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/ServiceProvider.ts#L36)
77
+ [src/ServiceProvider.ts:36](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/ServiceProvider.ts#L33)
91
+ [src/ServiceProvider.ts:33](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/ServiceProvider.ts#L44)
105
+ [src/ServiceProvider.ts:44](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/ServiceProvider.ts#L34)
119
+ [src/ServiceProvider.ts:34](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/ServiceProvider.ts#L56)
133
+ [src/ServiceProvider.ts:56](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/ServiceProvider.ts#L157)
157
+ [src/ServiceProvider.ts:157](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/ServiceProvider.ts#L142)
181
+ [src/ServiceProvider.ts:142](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/ServiceProvider.ts#L40)
195
+ [src/ServiceProvider.ts:40](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/ServiceProvider.ts#L60)
209
+ [src/ServiceProvider.ts:60](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/ServiceProvider.ts#L147)
233
+ [src/ServiceProvider.ts:147](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/ServiceProvider.ts#L152)
257
+ [src/ServiceProvider.ts:152](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/ServiceProvider.ts#L82)
282
+ [src/ServiceProvider.ts:82](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/ServiceProvider.ts#L52)
296
+ [src/ServiceProvider.ts:52](https://github.com/breautek/storm/blob/3748147/src/ServiceProvider.ts#L52)
package/docs/classes/ServiceResponse.md CHANGED
@@ -12,6 +12,7 @@
12
12
 
13
13
  - [getJSON](ServiceResponse.md#getjson)
14
14
  - [getRaw](ServiceResponse.md#getraw)
15
+ - [getStatusCode](ServiceResponse.md#getstatuscode)
15
16
  - [getUTF8](ServiceResponse.md#getutf8)
16
17
 
17
18
  ## Constructors
@@ -29,7 +30,7 @@
29
30
 
30
31
  #### Defined in
31
32
 
32
- [src/ServiceResponse.ts:23](https://github.com/breautek/storm/blob/5fbba2d/src/ServiceResponse.ts#L23)
33
+ [src/ServiceResponse.ts:24](https://github.com/breautek/storm/blob/3748147/src/ServiceResponse.ts#L24)
33
34
 
34
35
  ## Methods
35
36
 
@@ -43,7 +44,7 @@
43
44
 
44
45
  #### Defined in
45
46
 
46
- [src/ServiceResponse.ts:36](https://github.com/breautek/storm/blob/5fbba2d/src/ServiceResponse.ts#L36)
47
+ [src/ServiceResponse.ts:37](https://github.com/breautek/storm/blob/3748147/src/ServiceResponse.ts#L37)
47
48
 
48
49
  ___
49
50
 
@@ -57,7 +58,21 @@ ___
57
58
 
58
59
  #### Defined in
59
60
 
60
- [src/ServiceResponse.ts:28](https://github.com/breautek/storm/blob/5fbba2d/src/ServiceResponse.ts#L28)
61
+ [src/ServiceResponse.ts:29](https://github.com/breautek/storm/blob/3748147/src/ServiceResponse.ts#L29)
62
+
63
+ ___
64
+
65
+ ### getStatusCode
66
+
67
+ ▸ **getStatusCode**(): [`StatusCode`](../enums/StatusCode.md)
68
+
69
+ #### Returns
70
+
71
+ [`StatusCode`](../enums/StatusCode.md)
72
+
73
+ #### Defined in
74
+
75
+ [src/ServiceResponse.ts:41](https://github.com/breautek/storm/blob/3748147/src/ServiceResponse.ts#L41)
61
76
 
62
77
  ___
63
78
 
@@ -71,4 +86,4 @@ ___
71
86
 
72
87
  #### Defined in
73
88
 
74
- [src/ServiceResponse.ts:32](https://github.com/breautek/storm/blob/5fbba2d/src/ServiceResponse.ts#L32)
89
+ [src/ServiceResponse.ts:33](https://github.com/breautek/storm/blob/3748147/src/ServiceResponse.ts#L33)
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/5fbba2d/src/Query.ts#L22)
45
+ [src/Query.ts:23](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L23)
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/5fbba2d/src/SetSessionVariableQuery.ts#L12)
63
+ [src/SetSessionVariableQuery.ts:12](https://github.com/breautek/storm/blob/3748147/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:70](https://github.com/breautek/storm/blob/5fbba2d/src/Query.ts#L70)
87
+ [src/Query.ts:71](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L71)
88
88
 
89
89
  ___
90
90
 
@@ -104,7 +104,7 @@ parameters that was passed into the constructor.
104
104
 
105
105
  #### Defined in
106
106
 
107
- [src/Query.ts:29](https://github.com/breautek/storm/blob/5fbba2d/src/Query.ts#L29)
107
+ [src/Query.ts:30](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L30)
108
108
 
109
109
  ___
110
110
 
@@ -126,7 +126,7 @@ parameters that will be used when this query is ran.
126
126
 
127
127
  #### Defined in
128
128
 
129
- [src/SetSessionVariableQuery.ts:23](https://github.com/breautek/storm/blob/5fbba2d/src/SetSessionVariableQuery.ts#L23)
129
+ [src/SetSessionVariableQuery.ts:23](https://github.com/breautek/storm/blob/3748147/src/SetSessionVariableQuery.ts#L23)
130
130
 
131
131
  ___
132
132
 
@@ -150,7 +150,7 @@ ___
150
150
 
151
151
  #### Defined in
152
152
 
153
- [src/Query.ts:44](https://github.com/breautek/storm/blob/5fbba2d/src/Query.ts#L44)
153
+ [src/Query.ts:45](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L45)
154
154
 
155
155
  ___
156
156
 
@@ -177,7 +177,7 @@ Override to augment/manipulate the returned result set.
177
177
 
178
178
  #### Defined in
179
179
 
180
- [src/Query.ts:65](https://github.com/breautek/storm/blob/5fbba2d/src/Query.ts#L65)
180
+ [src/Query.ts:66](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L66)
181
181
 
182
182
  ___
183
183
 
@@ -204,4 +204,4 @@ Can be used to set session variables or create temporary tables, etc.
204
204
 
205
205
  #### Defined in
206
206
 
207
- [src/Query.ts:55](https://github.com/breautek/storm/blob/5fbba2d/src/Query.ts#L55)
207
+ [src/Query.ts:56](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L56)
package/docs/classes/StormError.md CHANGED
@@ -91,7 +91,7 @@ Error.constructor
91
91
 
92
92
  #### Defined in
93
93
 
94
- [src/StormError.ts:44](https://github.com/breautek/storm/blob/5fbba2d/src/StormError.ts#L44)
94
+ [src/StormError.ts:44](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L44)
95
95
 
96
96
  ## Properties
97
97
 
@@ -196,7 +196,7 @@ node_modules/@types/node/globals.d.ts:13
196
196
 
197
197
  #### Defined in
198
198
 
199
- [src/StormError.ts:55](https://github.com/breautek/storm/blob/5fbba2d/src/StormError.ts#L55)
199
+ [src/StormError.ts:55](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L55)
200
200
 
201
201
  ___
202
202
 
@@ -210,7 +210,7 @@ ___
210
210
 
211
211
  #### Defined in
212
212
 
213
- [src/StormError.ts:76](https://github.com/breautek/storm/blob/5fbba2d/src/StormError.ts#L76)
213
+ [src/StormError.ts:76](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L76)
214
214
 
215
215
  ___
216
216
 
@@ -224,7 +224,7 @@ ___
224
224
 
225
225
  #### Defined in
226
226
 
227
- [src/StormError.ts:97](https://github.com/breautek/storm/blob/5fbba2d/src/StormError.ts#L97)
227
+ [src/StormError.ts:97](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L97)
228
228
 
229
229
  ___
230
230
 
@@ -238,7 +238,7 @@ ___
238
238
 
239
239
  #### Defined in
240
240
 
241
- [src/StormError.ts:72](https://github.com/breautek/storm/blob/5fbba2d/src/StormError.ts#L72)
241
+ [src/StormError.ts:72](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L72)
242
242
 
243
243
  ___
244
244
 
@@ -252,7 +252,7 @@ ___
252
252
 
253
253
  #### Defined in
254
254
 
255
- [src/StormError.ts:89](https://github.com/breautek/storm/blob/5fbba2d/src/StormError.ts#L89)
255
+ [src/StormError.ts:89](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L89)
256
256
 
257
257
  ___
258
258
 
@@ -266,7 +266,7 @@ ___
266
266
 
267
267
  #### Defined in
268
268
 
269
- [src/StormError.ts:93](https://github.com/breautek/storm/blob/5fbba2d/src/StormError.ts#L93)
269
+ [src/StormError.ts:93](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L93)
270
270
 
271
271
  ___
272
272
 
@@ -280,7 +280,7 @@ ___
280
280
 
281
281
  #### Defined in
282
282
 
283
- [src/StormError.ts:54](https://github.com/breautek/storm/blob/5fbba2d/src/StormError.ts#L54)
283
+ [src/StormError.ts:54](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L54)
284
284
 
285
285
  ___
286
286
 
@@ -297,7 +297,7 @@ They are kept secret from the client.
297
297
 
298
298
  #### Defined in
299
299
 
300
- [src/StormError.ts:68](https://github.com/breautek/storm/blob/5fbba2d/src/StormError.ts#L68)
300
+ [src/StormError.ts:68](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L68)
301
301
 
302
302
  ___
303
303
 
@@ -313,7 +313,7 @@ Sends details to the client.
313
313
 
314
314
  #### Defined in
315
315
 
316
- [src/StormError.ts:60](https://github.com/breautek/storm/blob/5fbba2d/src/StormError.ts#L60)
316
+ [src/StormError.ts:60](https://github.com/breautek/storm/blob/3748147/src/StormError.ts#L60)
317
317
 
318
318
  ___
319
319
 
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/5fbba2d/src/Query.ts#L22)
45
+ [src/Query.ts:23](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L23)
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/5fbba2d/src/TemporaryTableQuery.ts#L35)
69
+ [src/TemporaryTableQuery.ts:35](https://github.com/breautek/storm/blob/3748147/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:70](https://github.com/breautek/storm/blob/5fbba2d/src/Query.ts#L70)
93
+ [src/Query.ts:71](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L71)
94
94
 
95
95
  ___
96
96
 
@@ -110,7 +110,7 @@ parameters that was passed into the constructor.
110
110
 
111
111
  #### Defined in
112
112
 
113
- [src/Query.ts:29](https://github.com/breautek/storm/blob/5fbba2d/src/Query.ts#L29)
113
+ [src/Query.ts:30](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L30)
114
114
 
115
115
  ___
116
116
 
@@ -132,7 +132,7 @@ parameters that will be used when this query is ran.
132
132
 
133
133
  #### Defined in
134
134
 
135
- [src/TemporaryTableQuery.ts:27](https://github.com/breautek/storm/blob/5fbba2d/src/TemporaryTableQuery.ts#L27)
135
+ [src/TemporaryTableQuery.ts:27](https://github.com/breautek/storm/blob/3748147/src/TemporaryTableQuery.ts#L27)
136
136
 
137
137
  ___
138
138
 
@@ -156,7 +156,7 @@ ___
156
156
 
157
157
  #### Defined in
158
158
 
159
- [src/Query.ts:44](https://github.com/breautek/storm/blob/5fbba2d/src/Query.ts#L44)
159
+ [src/Query.ts:45](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L45)
160
160
 
161
161
  ___
162
162
 
@@ -183,7 +183,7 @@ Override to augment/manipulate the returned result set.
183
183
 
184
184
  #### Defined in
185
185
 
186
- [src/Query.ts:65](https://github.com/breautek/storm/blob/5fbba2d/src/Query.ts#L65)
186
+ [src/Query.ts:66](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L66)
187
187
 
188
188
  ___
189
189
 
@@ -210,4 +210,4 @@ Can be used to set session variables or create temporary tables, etc.
210
210
 
211
211
  #### Defined in
212
212
 
213
- [src/Query.ts:55](https://github.com/breautek/storm/blob/5fbba2d/src/Query.ts#L55)
213
+ [src/Query.ts:56](https://github.com/breautek/storm/blob/3748147/src/Query.ts#L56)
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/5fbba2d/src/Token.ts#L20)
29
+ [src/Token.ts:20](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/Token.ts#L24)
43
+ [src/Token.ts:24](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/TokenManager.ts#L29)
43
+ [src/TokenManager.ts:29](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/TokenManager.ts#L78)
63
+ [src/TokenManager.ts:78](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/TokenManager.ts#L33)
84
+ [src/TokenManager.ts:33](https://github.com/breautek/storm/blob/3748147/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/5fbba2d/src/TokenManager.ts#L56)
105
+ [src/TokenManager.ts:56](https://github.com/breautek/storm/blob/3748147/src/TokenManager.ts#L56)
package/docs/classes/Transaction.md ADDED
@@ -0,0 +1,161 @@
1
+ [@breautek/storm](../README.md) / Transaction
2
+
3
+ # Class: Transaction
4
+
5
+ A class encapsulating an entire transaction from beginning to commitment.
6
+
7
+ This encapsulates a routine to conduct for the transaction.
8
+ Should the transaction fail due to a deadlock, the transaction will automatically
9
+ be tried.
10
+
11
+ ## Implements
12
+
13
+ - [`IQueryable`](../interfaces/IQueryable.md)<`void`\>
14
+
15
+ ## Table of contents
16
+
17
+ ### Constructors
18
+
19
+ - [constructor](Transaction.md#constructor)
20
+
21
+ ### Methods
22
+
23
+ - [execute](Transaction.md#execute)
24
+ - [getParametersForQuery](Transaction.md#getparametersforquery)
25
+ - [getQuery](Transaction.md#getquery)
26
+ - [onPostProcess](Transaction.md#onpostprocess)
27
+ - [onPreQuery](Transaction.md#onprequery)
28
+
29
+ ## Constructors
30
+
31
+ ### constructor
32
+
33
+ • **new Transaction**(`app`, `executor`, `retryLimit?`, `isolationLevel?`)
34
+
35
+ #### Parameters
36
+
37
+ | Name | Type | Default value |
38
+ | :------ | :------ | :------ |
39
+ | `app` | [`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\> | `undefined` |
40
+ | `executor` | `ITransactionExecutor` | `undefined` |
41
+ | `retryLimit` | `number` | `Infinity` |
42
+ | `isolationLevel` | [`IsolationLevel`](../enums/IsolationLevel.md) | `IsolationLevel.REPEATABLE_READ` |
43
+
44
+ #### Defined in
45
+
46
+ [src/Transaction.ts:42](https://github.com/breautek/storm/blob/3748147/src/Transaction.ts#L42)
47
+
48
+ ## Methods
49
+
50
+ ### execute
51
+
52
+ ▸ **execute**(`connection`): `Promise`<`void`\>
53
+
54
+ #### Parameters
55
+
56
+ | Name | Type |
57
+ | :------ | :------ |
58
+ | `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
59
+
60
+ #### Returns
61
+
62
+ `Promise`<`void`\>
63
+
64
+ #### Implementation of
65
+
66
+ [IQueryable](../interfaces/IQueryable.md).[execute](../interfaces/IQueryable.md#execute)
67
+
68
+ #### Defined in
69
+
70
+ [src/Transaction.ts:69](https://github.com/breautek/storm/blob/3748147/src/Transaction.ts#L69)
71
+
72
+ ___
73
+
74
+ ### getParametersForQuery
75
+
76
+ ▸ **getParametersForQuery**(): `Record`<`string`, `any`\>
77
+
78
+ #### Returns
79
+
80
+ `Record`<`string`, `any`\>
81
+
82
+ #### Implementation of
83
+
84
+ [IQueryable](../interfaces/IQueryable.md).[getParametersForQuery](../interfaces/IQueryable.md#getparametersforquery)
85
+
86
+ #### Defined in
87
+
88
+ [src/Transaction.ts:62](https://github.com/breautek/storm/blob/3748147/src/Transaction.ts#L62)
89
+
90
+ ___
91
+
92
+ ### getQuery
93
+
94
+ ▸ **getQuery**(`connection`): `string`
95
+
96
+ #### Parameters
97
+
98
+ | Name | Type |
99
+ | :------ | :------ |
100
+ | `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
101
+
102
+ #### Returns
103
+
104
+ `string`
105
+
106
+ #### Implementation of
107
+
108
+ [IQueryable](../interfaces/IQueryable.md).[getQuery](../interfaces/IQueryable.md#getquery)
109
+
110
+ #### Defined in
111
+
112
+ [src/Transaction.ts:59](https://github.com/breautek/storm/blob/3748147/src/Transaction.ts#L59)
113
+
114
+ ___
115
+
116
+ ### onPostProcess
117
+
118
+ ▸ **onPostProcess**(`connection`, `results`): `Promise`<`void`\>
119
+
120
+ #### Parameters
121
+
122
+ | Name | Type |
123
+ | :------ | :------ |
124
+ | `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
125
+ | `results` | `any` |
126
+
127
+ #### Returns
128
+
129
+ `Promise`<`void`\>
130
+
131
+ #### Implementation of
132
+
133
+ [IQueryable](../interfaces/IQueryable.md).[onPostProcess](../interfaces/IQueryable.md#onpostprocess)
134
+
135
+ #### Defined in
136
+
137
+ [src/Transaction.ts:65](https://github.com/breautek/storm/blob/3748147/src/Transaction.ts#L65)
138
+
139
+ ___
140
+
141
+ ### onPreQuery
142
+
143
+ ▸ **onPreQuery**(`connection`): `Promise`<`void`\>
144
+
145
+ #### Parameters
146
+
147
+ | Name | Type |
148
+ | :------ | :------ |
149
+ | `connection` | [`IDatabaseConnection`](../interfaces/IDatabaseConnection.md) |
150
+
151
+ #### Returns
152
+
153
+ `Promise`<`void`\>
154
+
155
+ #### Implementation of
156
+
157
+ [IQueryable](../interfaces/IQueryable.md).[onPreQuery](../interfaces/IQueryable.md#onprequery)
158
+
159
+ #### Defined in
160
+
161
+ [src/Transaction.ts:57](https://github.com/breautek/storm/blob/3748147/src/Transaction.ts#L57)