@breautek/storm 4.3.0 → 4.4.1
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.
- package/CHANGELOG.md +14 -0
- package/docs/README.md +28 -20
- package/docs/classes/Application.md +158 -76
- package/docs/classes/BackendAuthenticationMiddleware.md +3 -3
- package/docs/classes/CORSMiddleware.md +8 -8
- package/docs/classes/ConfigLoader.md +1 -1
- package/docs/classes/Database.md +12 -12
- package/docs/classes/DatabaseConnection.md +42 -40
- package/docs/classes/DatabaseQueryError.md +22 -18
- package/docs/classes/DeadLockError.md +349 -0
- package/docs/classes/DiskSpaceError.md +20 -18
- package/docs/classes/DropTemporaryTableQuery.md +8 -8
- package/docs/classes/DumpStream.md +1 -1
- package/docs/classes/DuplicateEntryError.md +20 -18
- package/docs/classes/EntityNotFoundError.md +20 -18
- package/docs/classes/ExpiredTokenError.md +20 -18
- package/docs/classes/Handler.md +14 -14
- package/docs/classes/InternalError.md +20 -18
- package/docs/classes/InvalidCredentialsError.md +20 -18
- package/docs/classes/InvalidValueError.md +20 -18
- package/docs/classes/ManagedDatabaseConnection.md +19 -19
- package/docs/classes/Middleware.md +3 -3
- package/docs/classes/MissingConfigError.md +20 -18
- package/docs/classes/MissingParameterError.md +20 -18
- package/docs/classes/MySQLConnection.md +73 -43
- package/docs/classes/MySQLDatabase.md +13 -13
- package/docs/classes/NotImplementedError.md +20 -18
- package/docs/classes/Query.md +8 -8
- package/docs/classes/RawError.md +20 -20
- package/docs/classes/RawQuery.md +8 -8
- package/docs/classes/Request.md +18 -18
- package/docs/classes/Response.md +11 -11
- package/docs/classes/ResponseData.md +7 -7
- package/docs/classes/ServiceProvider.md +15 -15
- package/docs/classes/ServiceResponse.md +4 -4
- package/docs/classes/SetSessionVariableQuery.md +8 -8
- package/docs/classes/StormError.md +20 -18
- package/docs/classes/TemporaryTableQuery.md +8 -8
- package/docs/classes/Token.md +2 -2
- package/docs/classes/TokenManager.md +4 -4
- package/docs/classes/UnauthorizedAccessError.md +20 -18
- package/docs/enums/ErrorCode.md +18 -18
- package/docs/enums/ExitCode.md +4 -4
- package/docs/enums/HTTPMethod.md +8 -8
- package/docs/enums/JWTError.md +4 -4
- package/docs/enums/StatusCode.md +96 -96
- package/docs/interfaces/IConfig.md +8 -8
- package/docs/interfaces/IDatabaseConfig.md +6 -6
- package/docs/interfaces/IDatabaseConnection.md +14 -14
- package/docs/interfaces/IErrorResponse.md +5 -5
- package/docs/interfaces/IFormData.md +2 -2
- package/docs/interfaces/IHandler.md +1 -1
- package/docs/interfaces/IInsertQueryResult.md +3 -3
- package/docs/interfaces/IJWTVerifyOptions.md +1 -1
- package/docs/interfaces/IRequestResponse.md +2 -2
- package/docs/interfaces/ISetSessionVariableQueryInput.md +2 -2
- package/docs/interfaces/ITemporaryTableQueryInput.md +2 -2
- package/docs/interfaces/IUpdateQueryResult.md +2 -2
- package/docs/interfaces/formidable.File.md +3 -1
- package/docs/interfaces/formidable.FileJSON.md +3 -1
- package/docs/interfaces/formidable.Options.md +33 -11
- package/docs/interfaces/formidable.Part.md +65 -35
- package/lib/DeadLockError.d.ts +6 -0
- package/lib/DeadLockError.js +26 -0
- package/lib/DeadLockError.js.map +1 -0
- package/lib/MySQLConnection.js +11 -1
- package/lib/MySQLConnection.js.map +1 -1
- package/lib/api.d.ts +1 -0
- package/lib/api.js +3 -1
- package/lib/api.js.map +1 -1
- package/package.json +19 -18
- package/src/DeadLockError.ts +22 -0
- package/src/MySQLConnection.ts +13 -1
- 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/
|
|
28
|
+
[src/BackendAuthenticationMiddleware.ts:35](https://github.com/breautek/storm/blob/306a47f/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/
|
|
49
|
+
[src/BackendAuthenticationMiddleware.ts:46](https://github.com/breautek/storm/blob/306a47f/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/
|
|
49
|
+
[src/CORSMiddleware.ts:39](https://github.com/breautek/storm/blob/306a47f/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/
|
|
74
|
+
[src/CORSMiddleware.ts:75](https://github.com/breautek/storm/blob/306a47f/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/
|
|
99
|
+
[src/Middleware.ts:27](https://github.com/breautek/storm/blob/306a47f/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/
|
|
113
|
+
[src/CORSMiddleware.ts:54](https://github.com/breautek/storm/blob/306a47f/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/
|
|
127
|
+
[src/CORSMiddleware.ts:64](https://github.com/breautek/storm/blob/306a47f/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/
|
|
143
|
+
[src/CORSMiddleware.ts:50](https://github.com/breautek/storm/blob/306a47f/src/CORSMiddleware.ts#L50)
|
package/docs/classes/Database.md
CHANGED
|
@@ -50,7 +50,7 @@
|
|
|
50
50
|
|
|
51
51
|
#### Defined in
|
|
52
52
|
|
|
53
|
-
[src/Database.ts:27](https://github.com/breautek/storm/blob/
|
|
53
|
+
[src/Database.ts:27](https://github.com/breautek/storm/blob/306a47f/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/
|
|
74
|
+
[src/Database.ts:82](https://github.com/breautek/storm/blob/306a47f/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/
|
|
88
|
+
[src/Database.ts:81](https://github.com/breautek/storm/blob/306a47f/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/
|
|
109
|
+
[src/Database.ts:84](https://github.com/breautek/storm/blob/306a47f/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/
|
|
129
|
+
[src/Database.ts:83](https://github.com/breautek/storm/blob/306a47f/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/
|
|
149
|
+
[src/Database.ts:31](https://github.com/breautek/storm/blob/306a47f/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/
|
|
170
|
+
[src/Database.ts:45](https://github.com/breautek/storm/blob/306a47f/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/
|
|
184
|
+
[src/Database.ts:77](https://github.com/breautek/storm/blob/306a47f/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/
|
|
204
|
+
[src/Database.ts:85](https://github.com/breautek/storm/blob/306a47f/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/
|
|
225
|
+
[src/Database.ts:64](https://github.com/breautek/storm/blob/306a47f/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/
|
|
239
|
+
[src/Database.ts:40](https://github.com/breautek/storm/blob/306a47f/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/
|
|
259
|
+
[src/Database.ts:54](https://github.com/breautek/storm/blob/306a47f/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
|
-
**`
|
|
7
|
+
**`Abstract`**
|
|
8
8
|
|
|
9
|
-
**`
|
|
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/
|
|
78
|
+
[src/DatabaseConnection.ts:43](https://github.com/breautek/storm/blob/306a47f/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
|
-
**`
|
|
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/
|
|
105
|
+
[src/DatabaseConnection.ts:238](https://github.com/breautek/storm/blob/306a47f/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
|
-
**`
|
|
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/
|
|
138
|
+
[src/DatabaseConnection.ts:249](https://github.com/breautek/storm/blob/306a47f/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/
|
|
165
|
+
[src/DatabaseConnection.ts:261](https://github.com/breautek/storm/blob/306a47f/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
|
-
**`
|
|
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/
|
|
197
|
+
[src/DatabaseConnection.ts:168](https://github.com/breautek/storm/blob/306a47f/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
|
-
**`
|
|
207
|
+
**`Abstract`**
|
|
206
208
|
|
|
207
|
-
**`
|
|
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/
|
|
223
|
+
[src/DatabaseConnection.ts:219](https://github.com/breautek/storm/blob/306a47f/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
|
-
**`
|
|
233
|
+
**`Abstract`**
|
|
232
234
|
|
|
233
|
-
**`
|
|
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/
|
|
251
|
+
[src/DatabaseConnection.ts:210](https://github.com/breautek/storm/blob/306a47f/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/
|
|
273
|
+
[src/DatabaseConnection.ts:90](https://github.com/breautek/storm/blob/306a47f/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/
|
|
296
|
+
[src/DatabaseConnection.ts:72](https://github.com/breautek/storm/blob/306a47f/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/
|
|
318
|
+
[src/DatabaseConnection.ts:120](https://github.com/breautek/storm/blob/306a47f/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/
|
|
338
|
+
[src/DatabaseConnection.ts:181](https://github.com/breautek/storm/blob/306a47f/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/
|
|
361
|
+
[src/DatabaseConnection.ts:99](https://github.com/breautek/storm/blob/306a47f/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
|
-
**`
|
|
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/
|
|
385
|
+
[src/DatabaseConnection.ts:200](https://github.com/breautek/storm/blob/306a47f/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
|
-
**`
|
|
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/
|
|
421
|
+
[src/DatabaseConnection.ts:131](https://github.com/breautek/storm/blob/306a47f/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
|
-
**`
|
|
431
|
+
**`Abstract`**
|
|
430
432
|
|
|
431
|
-
**`
|
|
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/
|
|
447
|
+
[src/DatabaseConnection.ts:228](https://github.com/breautek/storm/blob/306a47f/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/
|
|
471
|
+
[src/DatabaseConnection.ts:63](https://github.com/breautek/storm/blob/306a47f/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/
|
|
497
|
+
[src/DatabaseConnection.ts:108](https://github.com/breautek/storm/blob/306a47f/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
|
-
**`
|
|
507
|
+
**`Abstract`**
|
|
506
508
|
|
|
507
|
-
**`
|
|
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/
|
|
523
|
+
[src/DatabaseConnection.ts:192](https://github.com/breautek/storm/blob/306a47f/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/
|
|
550
|
+
[src/DatabaseConnection.ts:151](https://github.com/breautek/storm/blob/306a47f/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
|
|
@@ -54,7 +56,7 @@
|
|
|
54
56
|
|
|
55
57
|
#### Defined in
|
|
56
58
|
|
|
57
|
-
[src/DatabaseQueryError.ts:25](https://github.com/breautek/storm/blob/
|
|
59
|
+
[src/DatabaseQueryError.ts:25](https://github.com/breautek/storm/blob/306a47f/src/DatabaseQueryError.ts#L25)
|
|
58
60
|
|
|
59
61
|
## Properties
|
|
60
62
|
|
|
@@ -68,7 +70,7 @@
|
|
|
68
70
|
|
|
69
71
|
#### Defined in
|
|
70
72
|
|
|
71
|
-
node_modules/typescript/lib/lib.es5.d.ts:
|
|
73
|
+
node_modules/typescript/lib/lib.es5.d.ts:1041
|
|
72
74
|
|
|
73
75
|
___
|
|
74
76
|
|
|
@@ -82,7 +84,7 @@ ___
|
|
|
82
84
|
|
|
83
85
|
#### Defined in
|
|
84
86
|
|
|
85
|
-
node_modules/typescript/lib/lib.es5.d.ts:
|
|
87
|
+
node_modules/typescript/lib/lib.es5.d.ts:1040
|
|
86
88
|
|
|
87
89
|
___
|
|
88
90
|
|
|
@@ -96,7 +98,7 @@ ___
|
|
|
96
98
|
|
|
97
99
|
#### Defined in
|
|
98
100
|
|
|
99
|
-
node_modules/typescript/lib/lib.es5.d.ts:
|
|
101
|
+
node_modules/typescript/lib/lib.es5.d.ts:1042
|
|
100
102
|
|
|
101
103
|
___
|
|
102
104
|
|
|
@@ -110,7 +112,9 @@ ___
|
|
|
110
112
|
|
|
111
113
|
Optional override for formatting stack traces
|
|
112
114
|
|
|
113
|
-
**`
|
|
115
|
+
**`See`**
|
|
116
|
+
|
|
117
|
+
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
114
118
|
|
|
115
119
|
##### Parameters
|
|
116
120
|
|
|
@@ -129,7 +133,7 @@ Optional override for formatting stack traces
|
|
|
129
133
|
|
|
130
134
|
#### Defined in
|
|
131
135
|
|
|
132
|
-
node_modules/@types/node/globals.d.ts:11
|
|
136
|
+
node_modules/@types/node/ts4.8/globals.d.ts:11
|
|
133
137
|
|
|
134
138
|
___
|
|
135
139
|
|
|
@@ -143,7 +147,7 @@ ___
|
|
|
143
147
|
|
|
144
148
|
#### Defined in
|
|
145
149
|
|
|
146
|
-
node_modules/@types/node/globals.d.ts:13
|
|
150
|
+
node_modules/@types/node/ts4.8/globals.d.ts:13
|
|
147
151
|
|
|
148
152
|
## Methods
|
|
149
153
|
|
|
@@ -161,7 +165,7 @@ node_modules/@types/node/globals.d.ts:13
|
|
|
161
165
|
|
|
162
166
|
#### Defined in
|
|
163
167
|
|
|
164
|
-
[src/DatabaseQueryError.ts:36](https://github.com/breautek/storm/blob/
|
|
168
|
+
[src/DatabaseQueryError.ts:36](https://github.com/breautek/storm/blob/306a47f/src/DatabaseQueryError.ts#L36)
|
|
165
169
|
|
|
166
170
|
___
|
|
167
171
|
|
|
@@ -179,7 +183,7 @@ ___
|
|
|
179
183
|
|
|
180
184
|
#### Defined in
|
|
181
185
|
|
|
182
|
-
[src/StormError.ts:76](https://github.com/breautek/storm/blob/
|
|
186
|
+
[src/StormError.ts:76](https://github.com/breautek/storm/blob/306a47f/src/StormError.ts#L76)
|
|
183
187
|
|
|
184
188
|
___
|
|
185
189
|
|
|
@@ -197,7 +201,7 @@ ___
|
|
|
197
201
|
|
|
198
202
|
#### Defined in
|
|
199
203
|
|
|
200
|
-
[src/StormError.ts:97](https://github.com/breautek/storm/blob/
|
|
204
|
+
[src/StormError.ts:97](https://github.com/breautek/storm/blob/306a47f/src/StormError.ts#L97)
|
|
201
205
|
|
|
202
206
|
___
|
|
203
207
|
|
|
@@ -215,7 +219,7 @@ ___
|
|
|
215
219
|
|
|
216
220
|
#### Defined in
|
|
217
221
|
|
|
218
|
-
[src/DatabaseQueryError.ts:40](https://github.com/breautek/storm/blob/
|
|
222
|
+
[src/DatabaseQueryError.ts:40](https://github.com/breautek/storm/blob/306a47f/src/DatabaseQueryError.ts#L40)
|
|
219
223
|
|
|
220
224
|
___
|
|
221
225
|
|
|
@@ -233,7 +237,7 @@ ___
|
|
|
233
237
|
|
|
234
238
|
#### Defined in
|
|
235
239
|
|
|
236
|
-
[src/DatabaseQueryError.ts:44](https://github.com/breautek/storm/blob/
|
|
240
|
+
[src/DatabaseQueryError.ts:44](https://github.com/breautek/storm/blob/306a47f/src/DatabaseQueryError.ts#L44)
|
|
237
241
|
|
|
238
242
|
___
|
|
239
243
|
|
|
@@ -251,7 +255,7 @@ ___
|
|
|
251
255
|
|
|
252
256
|
#### Defined in
|
|
253
257
|
|
|
254
|
-
[src/StormError.ts:93](https://github.com/breautek/storm/blob/
|
|
258
|
+
[src/StormError.ts:93](https://github.com/breautek/storm/blob/306a47f/src/StormError.ts#L93)
|
|
255
259
|
|
|
256
260
|
___
|
|
257
261
|
|
|
@@ -269,7 +273,7 @@ ___
|
|
|
269
273
|
|
|
270
274
|
#### Defined in
|
|
271
275
|
|
|
272
|
-
[src/DatabaseQueryError.ts:32](https://github.com/breautek/storm/blob/
|
|
276
|
+
[src/DatabaseQueryError.ts:32](https://github.com/breautek/storm/blob/306a47f/src/DatabaseQueryError.ts#L32)
|
|
273
277
|
|
|
274
278
|
___
|
|
275
279
|
|
|
@@ -277,7 +281,7 @@ ___
|
|
|
277
281
|
|
|
278
282
|
▸ **getPrivateDetails**(): `Object`
|
|
279
283
|
|
|
280
|
-
Private details are only logged to the server log.
|
|
284
|
+
Private details are only logged to the server log.
|
|
281
285
|
They are kept secret from the client.
|
|
282
286
|
|
|
283
287
|
#### Returns
|
|
@@ -295,7 +299,7 @@ They are kept secret from the client.
|
|
|
295
299
|
|
|
296
300
|
#### Defined in
|
|
297
301
|
|
|
298
|
-
[src/StormError.ts:68](https://github.com/breautek/storm/blob/
|
|
302
|
+
[src/StormError.ts:68](https://github.com/breautek/storm/blob/306a47f/src/StormError.ts#L68)
|
|
299
303
|
|
|
300
304
|
___
|
|
301
305
|
|
|
@@ -315,7 +319,7 @@ Sends details to the client.
|
|
|
315
319
|
|
|
316
320
|
#### Defined in
|
|
317
321
|
|
|
318
|
-
[src/StormError.ts:60](https://github.com/breautek/storm/blob/
|
|
322
|
+
[src/StormError.ts:60](https://github.com/breautek/storm/blob/306a47f/src/StormError.ts#L60)
|
|
319
323
|
|
|
320
324
|
___
|
|
321
325
|
|
|
@@ -342,4 +346,4 @@ Create .stack property on a target object
|
|
|
342
346
|
|
|
343
347
|
#### Defined in
|
|
344
348
|
|
|
345
|
-
node_modules/@types/node/globals.d.ts:4
|
|
349
|
+
node_modules/@types/node/ts4.8/globals.d.ts:4
|