@breautek/storm 4.2.0 → 4.4.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 (126) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/docs/README.md +28 -20
  3. package/docs/classes/Application.md +158 -76
  4. package/docs/classes/BackendAuthenticationMiddleware.md +3 -3
  5. package/docs/classes/CORSMiddleware.md +8 -8
  6. package/docs/classes/ConfigLoader.md +1 -1
  7. package/docs/classes/Database.md +12 -12
  8. package/docs/classes/DatabaseConnection.md +42 -40
  9. package/docs/classes/DatabaseQueryError.md +58 -16
  10. package/docs/classes/DeadLockError.md +349 -0
  11. package/docs/classes/DiskSpaceError.md +56 -16
  12. package/docs/classes/DropTemporaryTableQuery.md +8 -8
  13. package/docs/classes/DumpStream.md +1 -1
  14. package/docs/classes/DuplicateEntryError.md +56 -16
  15. package/docs/classes/EntityNotFoundError.md +56 -16
  16. package/docs/classes/ExpiredTokenError.md +56 -16
  17. package/docs/classes/Handler.md +14 -14
  18. package/docs/classes/InternalError.md +56 -16
  19. package/docs/classes/InvalidCredentialsError.md +56 -16
  20. package/docs/classes/InvalidValueError.md +56 -16
  21. package/docs/classes/ManagedDatabaseConnection.md +19 -19
  22. package/docs/classes/Middleware.md +3 -3
  23. package/docs/classes/MissingConfigError.md +56 -16
  24. package/docs/classes/MissingParameterError.md +56 -16
  25. package/docs/classes/MySQLConnection.md +73 -43
  26. package/docs/classes/MySQLDatabase.md +13 -13
  27. package/docs/classes/NotImplementedError.md +56 -16
  28. package/docs/classes/Query.md +8 -8
  29. package/docs/classes/RawError.md +56 -18
  30. package/docs/classes/RawQuery.md +8 -8
  31. package/docs/classes/Request.md +18 -18
  32. package/docs/classes/Response.md +11 -11
  33. package/docs/classes/ResponseData.md +7 -7
  34. package/docs/classes/ServiceProvider.md +15 -15
  35. package/docs/classes/ServiceResponse.md +4 -4
  36. package/docs/classes/SetSessionVariableQuery.md +8 -8
  37. package/docs/classes/StormError.md +48 -16
  38. package/docs/classes/TemporaryTableQuery.md +8 -8
  39. package/docs/classes/Token.md +2 -2
  40. package/docs/classes/TokenManager.md +4 -4
  41. package/docs/classes/UnauthorizedAccessError.md +56 -16
  42. package/docs/enums/ErrorCode.md +18 -18
  43. package/docs/enums/ExitCode.md +4 -4
  44. package/docs/enums/HTTPMethod.md +8 -8
  45. package/docs/enums/JWTError.md +4 -4
  46. package/docs/enums/StatusCode.md +96 -96
  47. package/docs/interfaces/IConfig.md +8 -8
  48. package/docs/interfaces/IDatabaseConfig.md +6 -6
  49. package/docs/interfaces/IDatabaseConnection.md +14 -14
  50. package/docs/interfaces/IErrorResponse.md +15 -4
  51. package/docs/interfaces/IFormData.md +2 -2
  52. package/docs/interfaces/IHandler.md +1 -1
  53. package/docs/interfaces/IInsertQueryResult.md +3 -3
  54. package/docs/interfaces/IJWTVerifyOptions.md +1 -1
  55. package/docs/interfaces/IRequestResponse.md +2 -2
  56. package/docs/interfaces/ISetSessionVariableQueryInput.md +2 -2
  57. package/docs/interfaces/ITemporaryTableQueryInput.md +2 -2
  58. package/docs/interfaces/IUpdateQueryResult.md +2 -2
  59. package/docs/interfaces/formidable.File.md +3 -1
  60. package/docs/interfaces/formidable.FileJSON.md +3 -1
  61. package/docs/interfaces/formidable.Options.md +33 -11
  62. package/docs/interfaces/formidable.Part.md +65 -35
  63. package/lib/DatabaseQueryError.d.ts +1 -0
  64. package/lib/DatabaseQueryError.js +3 -0
  65. package/lib/DatabaseQueryError.js.map +1 -1
  66. package/lib/DeadLockError.d.ts +6 -0
  67. package/lib/DeadLockError.js +26 -0
  68. package/lib/DeadLockError.js.map +1 -0
  69. package/lib/DiskSpaceError.d.ts +1 -0
  70. package/lib/DiskSpaceError.js +3 -0
  71. package/lib/DiskSpaceError.js.map +1 -1
  72. package/lib/DuplicateEntryError.d.ts +2 -0
  73. package/lib/DuplicateEntryError.js +11 -0
  74. package/lib/DuplicateEntryError.js.map +1 -1
  75. package/lib/EntityNotFoundError.d.ts +2 -0
  76. package/lib/EntityNotFoundError.js +8 -0
  77. package/lib/EntityNotFoundError.js.map +1 -1
  78. package/lib/ExpiredTokenError.d.ts +1 -0
  79. package/lib/ExpiredTokenError.js +3 -0
  80. package/lib/ExpiredTokenError.js.map +1 -1
  81. package/lib/InternalError.d.ts +1 -0
  82. package/lib/InternalError.js +3 -0
  83. package/lib/InternalError.js.map +1 -1
  84. package/lib/InvalidCredentialsError.d.ts +1 -0
  85. package/lib/InvalidCredentialsError.js +3 -0
  86. package/lib/InvalidCredentialsError.js.map +1 -1
  87. package/lib/InvalidValueError.d.ts +2 -0
  88. package/lib/InvalidValueError.js +11 -0
  89. package/lib/InvalidValueError.js.map +1 -1
  90. package/lib/MissingConfigError.d.ts +2 -0
  91. package/lib/MissingConfigError.js +8 -0
  92. package/lib/MissingConfigError.js.map +1 -1
  93. package/lib/MissingParameterError.d.ts +2 -0
  94. package/lib/MissingParameterError.js +8 -0
  95. package/lib/MissingParameterError.js.map +1 -1
  96. package/lib/MySQLConnection.js +9 -1
  97. package/lib/MySQLConnection.js.map +1 -1
  98. package/lib/NotImplementedError.d.ts +2 -0
  99. package/lib/NotImplementedError.js +8 -0
  100. package/lib/NotImplementedError.js.map +1 -1
  101. package/lib/StormError.d.ts +7 -0
  102. package/lib/StormError.js +10 -0
  103. package/lib/StormError.js.map +1 -1
  104. package/lib/UnauthorizedAccessError.d.ts +1 -0
  105. package/lib/UnauthorizedAccessError.js +3 -0
  106. package/lib/UnauthorizedAccessError.js.map +1 -1
  107. package/lib/api.d.ts +1 -0
  108. package/lib/api.js +3 -1
  109. package/lib/api.js.map +1 -1
  110. package/package.json +19 -18
  111. package/src/DatabaseQueryError.ts +4 -0
  112. package/src/DeadLockError.ts +22 -0
  113. package/src/DiskSpaceError.ts +4 -0
  114. package/src/DuplicateEntryError.ts +13 -0
  115. package/src/EntityNotFoundError.ts +10 -0
  116. package/src/ExpiredTokenError.ts +4 -0
  117. package/src/InternalError.ts +4 -0
  118. package/src/InvalidCredentialsError.ts +4 -0
  119. package/src/InvalidValueError.ts +13 -0
  120. package/src/MissingConfigError.ts +10 -0
  121. package/src/MissingParameterError.ts +10 -0
  122. package/src/MySQLConnection.ts +11 -1
  123. package/src/NotImplementedError.ts +10 -0
  124. package/src/StormError.ts +18 -0
  125. package/src/UnauthorizedAccessError.ts +4 -0
  126. package/src/api.ts +1 -0
@@ -4,7 +4,7 @@
4
4
 
5
5
  A base authentication strategy that handles 90% of the authentication process.
6
6
  This will verify that the token hasn't been manipulated or tainted.
7
- The authenticate API must be implemented by subclasses to further validate the token data
7
+ The authenticate API must be implemented by subclasses to further validate the token data
8
8
  for their specific use cases.
9
9
 
10
10
  ## Table of contents
@@ -25,7 +25,7 @@ for their specific use cases.
25
25
 
26
26
  #### Defined in
27
27
 
28
- [src/BackendAuthenticationMiddleware.ts:35](https://github.com/breautek/storm/blob/f198938/src/BackendAuthenticationMiddleware.ts#L35)
28
+ [src/BackendAuthenticationMiddleware.ts:35](https://github.com/breautek/storm/blob/0875c73/src/BackendAuthenticationMiddleware.ts#L35)
29
29
 
30
30
  ## Methods
31
31
 
@@ -46,4 +46,4 @@ for their specific use cases.
46
46
 
47
47
  #### Defined in
48
48
 
49
- [src/BackendAuthenticationMiddleware.ts:46](https://github.com/breautek/storm/blob/f198938/src/BackendAuthenticationMiddleware.ts#L46)
49
+ [src/BackendAuthenticationMiddleware.ts:46](https://github.com/breautek/storm/blob/0875c73/src/BackendAuthenticationMiddleware.ts#L46)
@@ -2,8 +2,8 @@
2
2
 
3
3
  # Class: CORSMiddleware
4
4
 
5
- CORSMiddleware is used to enable CORS on APIs.
6
- It will automatically add the necessary headers necessary to
5
+ CORSMiddleware is used to enable CORS on APIs.
6
+ It will automatically add the necessary headers necessary to
7
7
  communicate with CORS enabled clients.
8
8
 
9
9
  ## Hierarchy
@@ -46,7 +46,7 @@ communicate with CORS enabled clients.
46
46
 
47
47
  #### Defined in
48
48
 
49
- [src/CORSMiddleware.ts:39](https://github.com/breautek/storm/blob/f198938/src/CORSMiddleware.ts#L39)
49
+ [src/CORSMiddleware.ts:39](https://github.com/breautek/storm/blob/0875c73/src/CORSMiddleware.ts#L39)
50
50
 
51
51
  ## Methods
52
52
 
@@ -71,7 +71,7 @@ communicate with CORS enabled clients.
71
71
 
72
72
  #### Defined in
73
73
 
74
- [src/CORSMiddleware.ts:75](https://github.com/breautek/storm/blob/f198938/src/CORSMiddleware.ts#L75)
74
+ [src/CORSMiddleware.ts:75](https://github.com/breautek/storm/blob/0875c73/src/CORSMiddleware.ts#L75)
75
75
 
76
76
  ___
77
77
 
@@ -96,7 +96,7 @@ ___
96
96
 
97
97
  #### Defined in
98
98
 
99
- [src/Middleware.ts:27](https://github.com/breautek/storm/blob/f198938/src/Middleware.ts#L27)
99
+ [src/Middleware.ts:27](https://github.com/breautek/storm/blob/0875c73/src/Middleware.ts#L27)
100
100
 
101
101
  ___
102
102
 
@@ -110,7 +110,7 @@ ___
110
110
 
111
111
  #### Defined in
112
112
 
113
- [src/CORSMiddleware.ts:54](https://github.com/breautek/storm/blob/f198938/src/CORSMiddleware.ts#L54)
113
+ [src/CORSMiddleware.ts:54](https://github.com/breautek/storm/blob/0875c73/src/CORSMiddleware.ts#L54)
114
114
 
115
115
  ___
116
116
 
@@ -124,7 +124,7 @@ ___
124
124
 
125
125
  #### Defined in
126
126
 
127
- [src/CORSMiddleware.ts:64](https://github.com/breautek/storm/blob/f198938/src/CORSMiddleware.ts#L64)
127
+ [src/CORSMiddleware.ts:64](https://github.com/breautek/storm/blob/0875c73/src/CORSMiddleware.ts#L64)
128
128
 
129
129
  ___
130
130
 
@@ -140,4 +140,4 @@ Sets the allowed origin. By default,
140
140
 
141
141
  #### Defined in
142
142
 
143
- [src/CORSMiddleware.ts:50](https://github.com/breautek/storm/blob/f198938/src/CORSMiddleware.ts#L50)
143
+ [src/CORSMiddleware.ts:50](https://github.com/breautek/storm/blob/0875c73/src/CORSMiddleware.ts#L50)
@@ -26,4 +26,4 @@
26
26
 
27
27
  #### Defined in
28
28
 
29
- [src/ConfigLoader.ts:34](https://github.com/breautek/storm/blob/f198938/src/ConfigLoader.ts#L34)
29
+ [src/ConfigLoader.ts:34](https://github.com/breautek/storm/blob/0875c73/src/ConfigLoader.ts#L34)
@@ -50,7 +50,7 @@
50
50
 
51
51
  #### Defined in
52
52
 
53
- [src/Database.ts:27](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L27)
53
+ [src/Database.ts:27](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L27)
54
54
 
55
55
  ## Methods
56
56
 
@@ -71,7 +71,7 @@
71
71
 
72
72
  #### Defined in
73
73
 
74
- [src/Database.ts:82](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L82)
74
+ [src/Database.ts:82](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L82)
75
75
 
76
76
  ___
77
77
 
@@ -85,7 +85,7 @@ ___
85
85
 
86
86
  #### Defined in
87
87
 
88
- [src/Database.ts:81](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L81)
88
+ [src/Database.ts:81](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L81)
89
89
 
90
90
  ___
91
91
 
@@ -106,7 +106,7 @@ ___
106
106
 
107
107
  #### Defined in
108
108
 
109
- [src/Database.ts:84](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L84)
109
+ [src/Database.ts:84](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L84)
110
110
 
111
111
  ___
112
112
 
@@ -126,7 +126,7 @@ ___
126
126
 
127
127
  #### Defined in
128
128
 
129
- [src/Database.ts:83](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L83)
129
+ [src/Database.ts:83](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L83)
130
130
 
131
131
  ___
132
132
 
@@ -146,7 +146,7 @@ ___
146
146
 
147
147
  #### Defined in
148
148
 
149
- [src/Database.ts:31](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L31)
149
+ [src/Database.ts:31](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L31)
150
150
 
151
151
  ___
152
152
 
@@ -167,7 +167,7 @@ ___
167
167
 
168
168
  #### Defined in
169
169
 
170
- [src/Database.ts:45](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L45)
170
+ [src/Database.ts:45](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L45)
171
171
 
172
172
  ___
173
173
 
@@ -181,7 +181,7 @@ ___
181
181
 
182
182
  #### Defined in
183
183
 
184
- [src/Database.ts:77](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L77)
184
+ [src/Database.ts:77](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L77)
185
185
 
186
186
  ___
187
187
 
@@ -201,7 +201,7 @@ ___
201
201
 
202
202
  #### Defined in
203
203
 
204
- [src/Database.ts:85](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L85)
204
+ [src/Database.ts:85](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L85)
205
205
 
206
206
  ___
207
207
 
@@ -222,7 +222,7 @@ ___
222
222
 
223
223
  #### Defined in
224
224
 
225
- [src/Database.ts:64](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L64)
225
+ [src/Database.ts:64](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L64)
226
226
 
227
227
  ___
228
228
 
@@ -236,7 +236,7 @@ ___
236
236
 
237
237
  #### Defined in
238
238
 
239
- [src/Database.ts:40](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L40)
239
+ [src/Database.ts:40](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L40)
240
240
 
241
241
  ___
242
242
 
@@ -256,4 +256,4 @@ ___
256
256
 
257
257
  #### Defined in
258
258
 
259
- [src/Database.ts:54](https://github.com/breautek/storm/blob/f198938/src/Database.ts#L54)
259
+ [src/Database.ts:54](https://github.com/breautek/storm/blob/0875c73/src/Database.ts#L54)
@@ -4,9 +4,11 @@
4
4
 
5
5
  Do not call `new Database` directly. Use `Database.getConnection` to create a `DatabaseConnection` object.
6
6
 
7
- **`abstract`**
7
+ **`Abstract`**
8
8
 
9
- **`implements`** `IDatabaseConnection`
9
+ **`Implements`**
10
+
11
+ `IDatabaseConnection`
10
12
 
11
13
  ## Type parameters
12
14
 
@@ -73,7 +75,7 @@ Do not call `new Database` directly. Use `Database.getConnection` to create a `D
73
75
 
74
76
  #### Defined in
75
77
 
76
- [src/DatabaseConnection.ts:43](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L43)
78
+ [src/DatabaseConnection.ts:43](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L43)
77
79
 
78
80
  ## Methods
79
81
 
@@ -81,10 +83,10 @@ Do not call `new Database` directly. Use `Database.getConnection` to create a `D
81
83
 
82
84
  ▸ `Protected` `Abstract` **_close**(`forceClose`): `Promise`<`void`\>
83
85
 
84
- Implementation to close the connection, if `forceClose` is true, close the connection no matter what.
86
+ Implementation to close the connection, if `forceClose` is true, close the connection no matter what.
85
87
  Silently error if it means the connection is closed.
86
88
 
87
- **`async`**
89
+ **`Async`**
88
90
 
89
91
  #### Parameters
90
92
 
@@ -100,7 +102,7 @@ Promise<void>
100
102
 
101
103
  #### Defined in
102
104
 
103
- [src/DatabaseConnection.ts:238](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L238)
105
+ [src/DatabaseConnection.ts:238](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L238)
104
106
 
105
107
  ___
106
108
 
@@ -110,7 +112,7 @@ ___
110
112
 
111
113
  Implementation method to return a dataset from the database
112
114
 
113
- **`async`**
115
+ **`Async`**
114
116
 
115
117
  #### Type parameters
116
118
 
@@ -133,7 +135,7 @@ Promise
133
135
 
134
136
  #### Defined in
135
137
 
136
- [src/DatabaseConnection.ts:249](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L249)
138
+ [src/DatabaseConnection.ts:249](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L249)
137
139
 
138
140
  ___
139
141
 
@@ -141,7 +143,7 @@ ___
141
143
 
142
144
  ▸ `Protected` `Abstract` **_stream**(`query`, `params?`, `streamOptions?`): `Readable`
143
145
 
144
- Implementation method to return a dataset from the database like `query()`,
146
+ Implementation method to return a dataset from the database like `query()`,
145
147
  but returns a `Readable` stream instead.
146
148
 
147
149
  #### Parameters
@@ -160,7 +162,7 @@ but returns a `Readable` stream instead.
160
162
 
161
163
  #### Defined in
162
164
 
163
- [src/DatabaseConnection.ts:261](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L261)
165
+ [src/DatabaseConnection.ts:261](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L261)
164
166
 
165
167
  ___
166
168
 
@@ -168,11 +170,11 @@ ___
168
170
 
169
171
  ▸ **close**(`forceClose?`): `Promise`<`void`\>
170
172
 
171
- Closes the connection. May error if connection has an active transaction.
172
- if `forceClose` boolean is true, it will force close the connection, regardless
173
+ Closes the connection. May error if connection has an active transaction.
174
+ if `forceClose` boolean is true, it will force close the connection, regardless
173
175
  of transaction state.
174
176
 
175
- **`async`**
177
+ **`Async`**
176
178
 
177
179
  #### Parameters
178
180
 
@@ -192,7 +194,7 @@ Promise<void>
192
194
 
193
195
  #### Defined in
194
196
 
195
- [src/DatabaseConnection.ts:168](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L168)
197
+ [src/DatabaseConnection.ts:168](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L168)
196
198
 
197
199
  ___
198
200
 
@@ -202,9 +204,9 @@ ___
202
204
 
203
205
  Commits a transaction. This will end a transaction.
204
206
 
205
- **`abstract`**
207
+ **`Abstract`**
206
208
 
207
- **`async`**
209
+ **`Async`**
208
210
 
209
211
  #### Returns
210
212
 
@@ -218,7 +220,7 @@ Promise<void>
218
220
 
219
221
  #### Defined in
220
222
 
221
- [src/DatabaseConnection.ts:219](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L219)
223
+ [src/DatabaseConnection.ts:219](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L219)
222
224
 
223
225
  ___
224
226
 
@@ -228,9 +230,9 @@ ___
228
230
 
229
231
  Ends a transaction. if `requiresRollback` is `true`, then `rollback()` is invoked. Otherwise, `commit()` is invoked.
230
232
 
231
- **`abstract`**
233
+ **`Abstract`**
232
234
 
233
- **`async`**
235
+ **`Async`**
234
236
 
235
237
  #### Parameters
236
238
 
@@ -246,7 +248,7 @@ Promise<void>
246
248
 
247
249
  #### Defined in
248
250
 
249
- [src/DatabaseConnection.ts:210](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L210)
251
+ [src/DatabaseConnection.ts:210](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L210)
250
252
 
251
253
  ___
252
254
 
@@ -268,7 +270,7 @@ any
268
270
 
269
271
  #### Defined in
270
272
 
271
- [src/DatabaseConnection.ts:90](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L90)
273
+ [src/DatabaseConnection.ts:90](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L90)
272
274
 
273
275
  ___
274
276
 
@@ -276,7 +278,7 @@ ___
276
278
 
277
279
  ▸ **getInstantiationStack**(): `string`
278
280
 
279
- Gets the callback stacktrace to determine what opened
281
+ Gets the callback stacktrace to determine what opened
280
282
  this connection. Useful for debugging lingering connections.
281
283
 
282
284
  #### Returns
@@ -291,7 +293,7 @@ string - A stacktrace
291
293
 
292
294
  #### Defined in
293
295
 
294
- [src/DatabaseConnection.ts:72](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L72)
296
+ [src/DatabaseConnection.ts:72](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L72)
295
297
 
296
298
  ___
297
299
 
@@ -313,7 +315,7 @@ number in milliseconds
313
315
 
314
316
  #### Defined in
315
317
 
316
- [src/DatabaseConnection.ts:120](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L120)
318
+ [src/DatabaseConnection.ts:120](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L120)
317
319
 
318
320
  ___
319
321
 
@@ -333,7 +335,7 @@ Returns true if the connection has been closed.
333
335
 
334
336
  #### Defined in
335
337
 
336
- [src/DatabaseConnection.ts:181](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L181)
338
+ [src/DatabaseConnection.ts:181](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L181)
337
339
 
338
340
  ___
339
341
 
@@ -341,7 +343,7 @@ ___
341
343
 
342
344
  ▸ **isReadOnly**(): `boolean`
343
345
 
344
- Returns true if connection was created without
346
+ Returns true if connection was created without
345
347
  write access
346
348
 
347
349
  #### Returns
@@ -356,7 +358,7 @@ boolean
356
358
 
357
359
  #### Defined in
358
360
 
359
- [src/DatabaseConnection.ts:99](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L99)
361
+ [src/DatabaseConnection.ts:99](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L99)
360
362
 
361
363
  ___
362
364
 
@@ -366,7 +368,7 @@ ___
366
368
 
367
369
  Implementation method to determine if the connection is in an active transaction.
368
370
 
369
- **`abstract`**
371
+ **`Abstract`**
370
372
 
371
373
  #### Returns
372
374
 
@@ -380,7 +382,7 @@ boolean
380
382
 
381
383
  #### Defined in
382
384
 
383
- [src/DatabaseConnection.ts:200](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L200)
385
+ [src/DatabaseConnection.ts:200](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L200)
384
386
 
385
387
  ___
386
388
 
@@ -390,7 +392,7 @@ ___
390
392
 
391
393
  Queries the database for a dataset.
392
394
 
393
- **`async`**
395
+ **`Async`**
394
396
 
395
397
  #### Type parameters
396
398
 
@@ -416,7 +418,7 @@ Promise<TQueryResult>
416
418
 
417
419
  #### Defined in
418
420
 
419
- [src/DatabaseConnection.ts:131](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L131)
421
+ [src/DatabaseConnection.ts:131](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L131)
420
422
 
421
423
  ___
422
424
 
@@ -426,9 +428,9 @@ ___
426
428
 
427
429
  Rollsback a transaction. This will end a transaction.
428
430
 
429
- **`abstract`**
431
+ **`Abstract`**
430
432
 
431
- **`async`**
433
+ **`Async`**
432
434
 
433
435
  #### Returns
434
436
 
@@ -442,7 +444,7 @@ Promise<void>
442
444
 
443
445
  #### Defined in
444
446
 
445
- [src/DatabaseConnection.ts:228](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L228)
447
+ [src/DatabaseConnection.ts:228](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L228)
446
448
 
447
449
  ___
448
450
 
@@ -466,7 +468,7 @@ ___
466
468
 
467
469
  #### Defined in
468
470
 
469
- [src/DatabaseConnection.ts:63](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L63)
471
+ [src/DatabaseConnection.ts:63](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L63)
470
472
 
471
473
  ___
472
474
 
@@ -492,7 +494,7 @@ Sets the timeout of this connectino
492
494
 
493
495
  #### Defined in
494
496
 
495
- [src/DatabaseConnection.ts:108](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L108)
497
+ [src/DatabaseConnection.ts:108](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L108)
496
498
 
497
499
  ___
498
500
 
@@ -502,9 +504,9 @@ ___
502
504
 
503
505
  Implementation method to start a transaction.
504
506
 
505
- **`abstract`**
507
+ **`Abstract`**
506
508
 
507
- **`async`**
509
+ **`Async`**
508
510
 
509
511
  #### Returns
510
512
 
@@ -518,7 +520,7 @@ Promise<void>
518
520
 
519
521
  #### Defined in
520
522
 
521
- [src/DatabaseConnection.ts:192](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L192)
523
+ [src/DatabaseConnection.ts:192](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L192)
522
524
 
523
525
  ___
524
526
 
@@ -545,4 +547,4 @@ Readable
545
547
 
546
548
  #### Defined in
547
549
 
548
- [src/DatabaseConnection.ts:151](https://github.com/breautek/storm/blob/f198938/src/DatabaseConnection.ts#L151)
550
+ [src/DatabaseConnection.ts:151](https://github.com/breautek/storm/blob/0875c73/src/DatabaseConnection.ts#L151)
@@ -8,6 +8,8 @@
8
8
 
9
9
  ↳ **`DatabaseQueryError`**
10
10
 
11
+ ↳↳ [`DeadLockError`](DeadLockError.md)
12
+
11
13
  ## Table of contents
12
14
 
13
15
  ### Constructors
@@ -28,6 +30,8 @@
28
30
  - [getErrorResponse](DatabaseQueryError.md#geterrorresponse)
29
31
  - [getExitCode](DatabaseQueryError.md#getexitcode)
30
32
  - [getHTTPCode](DatabaseQueryError.md#gethttpcode)
33
+ - [getLocaleCode](DatabaseQueryError.md#getlocalecode)
34
+ - [getLocaleParameters](DatabaseQueryError.md#getlocaleparameters)
31
35
  - [getMessage](DatabaseQueryError.md#getmessage)
32
36
  - [getPrivateDetails](DatabaseQueryError.md#getprivatedetails)
33
37
  - [getPublicDetails](DatabaseQueryError.md#getpublicdetails)
@@ -52,7 +56,7 @@
52
56
 
53
57
  #### Defined in
54
58
 
55
- [src/DatabaseQueryError.ts:25](https://github.com/breautek/storm/blob/f198938/src/DatabaseQueryError.ts#L25)
59
+ [src/DatabaseQueryError.ts:25](https://github.com/breautek/storm/blob/0875c73/src/DatabaseQueryError.ts#L25)
56
60
 
57
61
  ## Properties
58
62
 
@@ -66,7 +70,7 @@
66
70
 
67
71
  #### Defined in
68
72
 
69
- node_modules/typescript/lib/lib.es5.d.ts:1029
73
+ node_modules/typescript/lib/lib.es5.d.ts:1041
70
74
 
71
75
  ___
72
76
 
@@ -80,7 +84,7 @@ ___
80
84
 
81
85
  #### Defined in
82
86
 
83
- node_modules/typescript/lib/lib.es5.d.ts:1028
87
+ node_modules/typescript/lib/lib.es5.d.ts:1040
84
88
 
85
89
  ___
86
90
 
@@ -94,7 +98,7 @@ ___
94
98
 
95
99
  #### Defined in
96
100
 
97
- node_modules/typescript/lib/lib.es5.d.ts:1030
101
+ node_modules/typescript/lib/lib.es5.d.ts:1042
98
102
 
99
103
  ___
100
104
 
@@ -108,7 +112,9 @@ ___
108
112
 
109
113
  Optional override for formatting stack traces
110
114
 
111
- **`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
115
+ **`See`**
116
+
117
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
112
118
 
113
119
  ##### Parameters
114
120
 
@@ -127,7 +133,7 @@ Optional override for formatting stack traces
127
133
 
128
134
  #### Defined in
129
135
 
130
- node_modules/@types/node/globals.d.ts:11
136
+ node_modules/@types/node/ts4.8/globals.d.ts:11
131
137
 
132
138
  ___
133
139
 
@@ -141,7 +147,7 @@ ___
141
147
 
142
148
  #### Defined in
143
149
 
144
- node_modules/@types/node/globals.d.ts:13
150
+ node_modules/@types/node/ts4.8/globals.d.ts:13
145
151
 
146
152
  ## Methods
147
153
 
@@ -159,7 +165,7 @@ node_modules/@types/node/globals.d.ts:13
159
165
 
160
166
  #### Defined in
161
167
 
162
- [src/DatabaseQueryError.ts:36](https://github.com/breautek/storm/blob/f198938/src/DatabaseQueryError.ts#L36)
168
+ [src/DatabaseQueryError.ts:36](https://github.com/breautek/storm/blob/0875c73/src/DatabaseQueryError.ts#L36)
163
169
 
164
170
  ___
165
171
 
@@ -177,7 +183,7 @@ ___
177
183
 
178
184
  #### Defined in
179
185
 
180
- [src/StormError.ts:70](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L70)
186
+ [src/StormError.ts:76](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L76)
181
187
 
182
188
  ___
183
189
 
@@ -195,7 +201,7 @@ ___
195
201
 
196
202
  #### Defined in
197
203
 
198
- [src/StormError.ts:79](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L79)
204
+ [src/StormError.ts:97](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L97)
199
205
 
200
206
  ___
201
207
 
@@ -213,7 +219,43 @@ ___
213
219
 
214
220
  #### Defined in
215
221
 
216
- [src/DatabaseQueryError.ts:40](https://github.com/breautek/storm/blob/f198938/src/DatabaseQueryError.ts#L40)
222
+ [src/DatabaseQueryError.ts:40](https://github.com/breautek/storm/blob/0875c73/src/DatabaseQueryError.ts#L40)
223
+
224
+ ___
225
+
226
+ ### getLocaleCode
227
+
228
+ ▸ **getLocaleCode**(): `string`
229
+
230
+ #### Returns
231
+
232
+ `string`
233
+
234
+ #### Overrides
235
+
236
+ [StormError](StormError.md).[getLocaleCode](StormError.md#getlocalecode)
237
+
238
+ #### Defined in
239
+
240
+ [src/DatabaseQueryError.ts:44](https://github.com/breautek/storm/blob/0875c73/src/DatabaseQueryError.ts#L44)
241
+
242
+ ___
243
+
244
+ ### getLocaleParameters
245
+
246
+ ▸ **getLocaleParameters**(): `Record`<`string`, `string`\>
247
+
248
+ #### Returns
249
+
250
+ `Record`<`string`, `string`\>
251
+
252
+ #### Inherited from
253
+
254
+ [StormError](StormError.md).[getLocaleParameters](StormError.md#getlocaleparameters)
255
+
256
+ #### Defined in
257
+
258
+ [src/StormError.ts:93](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L93)
217
259
 
218
260
  ___
219
261
 
@@ -231,7 +273,7 @@ ___
231
273
 
232
274
  #### Defined in
233
275
 
234
- [src/DatabaseQueryError.ts:32](https://github.com/breautek/storm/blob/f198938/src/DatabaseQueryError.ts#L32)
276
+ [src/DatabaseQueryError.ts:32](https://github.com/breautek/storm/blob/0875c73/src/DatabaseQueryError.ts#L32)
235
277
 
236
278
  ___
237
279
 
@@ -239,7 +281,7 @@ ___
239
281
 
240
282
  ▸ **getPrivateDetails**(): `Object`
241
283
 
242
- Private details are only logged to the server log.
284
+ Private details are only logged to the server log.
243
285
  They are kept secret from the client.
244
286
 
245
287
  #### Returns
@@ -257,7 +299,7 @@ They are kept secret from the client.
257
299
 
258
300
  #### Defined in
259
301
 
260
- [src/StormError.ts:62](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L62)
302
+ [src/StormError.ts:68](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L68)
261
303
 
262
304
  ___
263
305
 
@@ -277,7 +319,7 @@ Sends details to the client.
277
319
 
278
320
  #### Defined in
279
321
 
280
- [src/StormError.ts:54](https://github.com/breautek/storm/blob/f198938/src/StormError.ts#L54)
322
+ [src/StormError.ts:60](https://github.com/breautek/storm/blob/0875c73/src/StormError.ts#L60)
281
323
 
282
324
  ___
283
325
 
@@ -304,4 +346,4 @@ Create .stack property on a target object
304
346
 
305
347
  #### Defined in
306
348
 
307
- node_modules/@types/node/globals.d.ts:4
349
+ node_modules/@types/node/ts4.8/globals.d.ts:4