@breautek/storm 3.1.2 → 3.3.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 +26 -0
- package/docs/classes/Application.Application-1.md +76 -24
- package/docs/classes/BackendAuthenticationMiddleware.BackendAuthenticationMiddleware-1.md +2 -2
- package/docs/classes/CORSMiddleware.CORSMiddleware-1.md +6 -6
- package/docs/classes/ConfigLoader.ConfigLoader-1.md +1 -1
- package/docs/classes/Database.Database-1.md +40 -10
- package/docs/classes/DatabaseConnection.DatabaseConnection-1.md +19 -19
- package/docs/classes/DatabaseQueryError.DatabaseQueryError-1.md +8 -8
- package/docs/classes/DiskSpaceError.DiskSpaceError-1.md +8 -8
- package/docs/classes/DropTemporaryTableQuery.DropTemporaryTableQuery-1.md +8 -8
- package/docs/classes/DumpStream.DumpStream-1.md +1 -1
- package/docs/classes/DuplicateEntryError.DuplicateEntryError-1.md +8 -8
- package/docs/classes/EntityNotFoundError.EntityNotFoundError-1.md +8 -8
- package/docs/classes/ExpiredTokenError.ExpiredTokenError-1.md +8 -8
- package/docs/classes/Handler.Handler-1.md +34 -13
- package/docs/classes/InternalError.InternalError-1.md +8 -8
- package/docs/classes/InvalidConfigError.InvalidConfigError-1.md +8 -8
- package/docs/classes/InvalidCredentialsError.InvalidCredentialsError-1.md +8 -8
- package/docs/classes/InvalidValueError.InvalidValueError-1.md +8 -8
- package/docs/classes/JWTVerifyOptionsParser.JWTVerifyOptionsParser-1.md +2 -2
- package/docs/classes/ManagedDatabaseConnection.ManagedDatabaseConnection-1.md +19 -19
- package/docs/classes/Middleware.Middleware-1.md +3 -3
- package/docs/classes/MissingConfigError.MissingConfigError-1.md +8 -8
- package/docs/classes/MissingParameterError.MissingParameterError-1.md +8 -8
- package/docs/classes/MySQLConnection.MySQLConnection-1.md +20 -20
- package/docs/classes/MySQLDatabase.MySQLDatabase-1.md +49 -11
- package/docs/classes/Query.Query-1.md +8 -8
- package/docs/classes/RawQuery.RawQuery-1.md +8 -8
- package/docs/classes/Request.Request-1.md +18 -18
- package/docs/classes/Response.Response-1.md +11 -11
- package/docs/classes/ResponseData.ResponseData-1.md +7 -7
- package/docs/classes/ServiceProvider.ServiceProvider-1.md +15 -15
- package/docs/classes/ServiceResponse.ServiceResponse-1.md +4 -4
- package/docs/classes/StormError.StormError-1.md +8 -8
- package/docs/classes/TemporaryTableQuery.TemporaryTableQuery-1.md +8 -8
- package/docs/classes/Token.Token-1.md +2 -2
- package/docs/classes/TokenManager.TokenManager-1.md +4 -4
- package/docs/classes/UnauthorizedAccessError.UnauthorizedAccessError-1.md +8 -8
- package/docs/classes/private_CommitQuery.CommitQuery.md +8 -8
- package/docs/classes/private_RollbackQuery.RollbackQuery.md +8 -8
- package/docs/classes/private_StartTransactionQuery.StartTransactionQuery.md +8 -8
- package/docs/enums/ApplicationEvent.ApplicationEvent-1.md +1 -1
- package/docs/enums/ErrorCode.ErrorCode-1.md +9 -9
- package/docs/enums/ExitCode.ExitCode-1.md +2 -2
- package/docs/enums/HTTPMethod.HTTPMethod-1.md +4 -4
- package/docs/enums/JWTError.JWTError-1.md +2 -2
- package/docs/enums/StatusCode.StatusCode-1.md +48 -48
- package/docs/interfaces/DropTemporaryTableQuery.IDropTemporaryTableQueryInput.md +1 -1
- package/docs/interfaces/IConfig.IConfig-1.md +8 -8
- package/docs/interfaces/IDatabaseConfig.IDatabaseConfig-1.md +6 -6
- package/docs/interfaces/IDatabaseConnection.IDatabaseConnection-1.md +14 -14
- package/docs/interfaces/IFormData.IFormData-1.md +2 -2
- package/docs/interfaces/IHandler.IHandler-1.md +1 -1
- package/docs/interfaces/IInsertQueryResult.IInsertQueryResult-1.md +3 -3
- package/docs/interfaces/IJWTVerifyOptions.IJWTVerifyOptions-1.md +1 -1
- package/docs/interfaces/IRequestResponse.IRequestResponse-1.md +2 -2
- package/docs/interfaces/IUpdateQueryResult.IUpdateQueryResult-1.md +2 -2
- package/docs/interfaces/StormError.IErrorResponse.md +4 -4
- package/docs/interfaces/TemporaryTableQuery.ITemporaryTableQueryInput.md +2 -2
- package/docs/modules/DatabaseConnection.md +2 -2
- package/docs/modules/Handler.md +2 -2
- package/docs/modules/IDeleteQueryResult.md +1 -1
- package/docs/modules/Response.md +1 -1
- package/docs/modules/instance.md +2 -2
- package/lib/Application.d.ts +4 -0
- package/lib/Application.js +12 -1
- package/lib/Application.js.map +1 -1
- package/lib/ConfigLoader.js +1 -1
- package/lib/ConfigLoader.js.map +1 -1
- package/lib/Database.d.ts +2 -0
- package/lib/Database.js +3 -0
- package/lib/Database.js.map +1 -1
- package/lib/Handler.d.ts +1 -0
- package/lib/Handler.js +2 -0
- package/lib/Handler.js.map +1 -1
- package/lib/MySQLDatabase.d.ts +1 -0
- package/lib/MySQLDatabase.js +11 -0
- package/lib/MySQLDatabase.js.map +1 -1
- package/package.json +20 -20
- package/src/Application.ts +15 -1
- package/src/ConfigLoader.ts +1 -1
- package/src/Database.ts +5 -0
- package/src/Handler.ts +4 -0
- package/src/MySQLDatabase.ts +13 -0
- package/src/defs/merge-change.d.ts +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -4,8 +4,34 @@ All notable changes to this project will be documented in this file. Dates are d
|
|
|
4
4
|
|
|
5
5
|
Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
|
|
6
6
|
|
|
7
|
+
#### [v3.3.1](https://github.com/breautek/storm/compare/v3.3.0...v3.3.1)
|
|
8
|
+
|
|
9
|
+
- deproll [`8c3a317`](https://github.com/breautek/storm/commit/8c3a3171d49f421b34d3c0d3660505fab0a7d136)
|
|
10
|
+
|
|
11
|
+
#### [v3.3.0](https://github.com/breautek/storm/compare/v3.2.1...v3.3.0)
|
|
12
|
+
|
|
13
|
+
> 23 November 2021
|
|
14
|
+
|
|
15
|
+
- feat: Allow accepting instances of Handlers for attachment [`621aeec`](https://github.com/breautek/storm/commit/621aeecc1929beee959d186467ef5f0ef326a56d)
|
|
16
|
+
|
|
17
|
+
#### [v3.2.1](https://github.com/breautek/storm/compare/v3.2.0...v3.2.1)
|
|
18
|
+
|
|
19
|
+
> 22 November 2021
|
|
20
|
+
|
|
21
|
+
- deproll [`8a65682`](https://github.com/breautek/storm/commit/8a656821743454af66978aae441d61242b8adb15)
|
|
22
|
+
- replaced merge-change with my own fork that contains vulnerability patches [`72412c9`](https://github.com/breautek/storm/commit/72412c9d391e4728bbd3af10ed5108cb2373b64e)
|
|
23
|
+
|
|
24
|
+
#### [v3.2.0](https://github.com/breautek/storm/compare/v3.1.2...v3.2.0)
|
|
25
|
+
|
|
26
|
+
> 3 October 2021
|
|
27
|
+
|
|
28
|
+
- deproll [`477d756`](https://github.com/breautek/storm/commit/477d7569db92758cec31c8a80a6ae53c5198d33a)
|
|
29
|
+
- breaking: Added _destroy abstract api to Database, intended for destroying connection pools [`a5c8a97`](https://github.com/breautek/storm/commit/a5c8a9708bc469a7191eb06d7a68289b1372543a)
|
|
30
|
+
|
|
7
31
|
#### [v3.1.2](https://github.com/breautek/storm/compare/v3.1.1...v3.1.2)
|
|
8
32
|
|
|
33
|
+
> 8 September 2021
|
|
34
|
+
|
|
9
35
|
- deproll [`012dd73`](https://github.com/breautek/storm/commit/012dd73e505c0ffaa91a18f2575c411fe7ed8579)
|
|
10
36
|
- Breaking changes docs [`824e19f`](https://github.com/breautek/storm/commit/824e19f1c6e50aadd7a4974c89892300b180b008)
|
|
11
37
|
- fix: BackendAuthenticationMiddleware from requiring the Request object, it was never actually used anyway [`6b087c5`](https://github.com/breautek/storm/commit/6b087c59033c9b8e607ea0e6e37d06f13c7ae28e)
|
|
@@ -38,6 +38,8 @@ Main entry point for the Application. Should be extended and have the abstract m
|
|
|
38
38
|
|
|
39
39
|
- [\_attachHandlers](Application.Application-1.md#_attachhandlers)
|
|
40
40
|
- [\_buildArgOptions](Application.Application-1.md#_buildargoptions)
|
|
41
|
+
- [\_closeDatabase](Application.Application-1.md#_closedatabase)
|
|
42
|
+
- [\_closeSocket](Application.Application-1.md#_closesocket)
|
|
41
43
|
- [\_initDB](Application.Application-1.md#_initdb)
|
|
42
44
|
- [\_initLogger](Application.Application-1.md#_initlogger)
|
|
43
45
|
- [\_initialize](Application.Application-1.md#_initialize)
|
|
@@ -46,6 +48,7 @@ Main entry point for the Application. Should be extended and have the abstract m
|
|
|
46
48
|
- [\_onReady](Application.Application-1.md#_onready)
|
|
47
49
|
- [addListener](Application.Application-1.md#addlistener)
|
|
48
50
|
- [attachHandler](Application.Application-1.md#attachhandler)
|
|
51
|
+
- [attachHandlerInstance](Application.Application-1.md#attachhandlerinstance)
|
|
49
52
|
- [close](Application.Application-1.md#close)
|
|
50
53
|
- [emit](Application.Application-1.md#emit)
|
|
51
54
|
- [eventNames](Application.Application-1.md#eventnames)
|
|
@@ -106,7 +109,7 @@ EventEmitter.constructor
|
|
|
106
109
|
|
|
107
110
|
#### Defined in
|
|
108
111
|
|
|
109
|
-
[src/Application.ts:64](https://github.com/breautek/storm/blob/
|
|
112
|
+
[src/Application.ts:64](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L64)
|
|
110
113
|
|
|
111
114
|
## Properties
|
|
112
115
|
|
|
@@ -190,7 +193,7 @@ Promise<void>
|
|
|
190
193
|
|
|
191
194
|
#### Defined in
|
|
192
195
|
|
|
193
|
-
[src/Application.ts:
|
|
196
|
+
[src/Application.ts:272](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L272)
|
|
194
197
|
|
|
195
198
|
___
|
|
196
199
|
|
|
@@ -210,7 +213,35 @@ ___
|
|
|
210
213
|
|
|
211
214
|
#### Defined in
|
|
212
215
|
|
|
213
|
-
[src/Application.ts:202](https://github.com/breautek/storm/blob/
|
|
216
|
+
[src/Application.ts:202](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L202)
|
|
217
|
+
|
|
218
|
+
___
|
|
219
|
+
|
|
220
|
+
### \_closeDatabase
|
|
221
|
+
|
|
222
|
+
▸ `Protected` **_closeDatabase**(): `Promise`<`void`\>
|
|
223
|
+
|
|
224
|
+
#### Returns
|
|
225
|
+
|
|
226
|
+
`Promise`<`void`\>
|
|
227
|
+
|
|
228
|
+
#### Defined in
|
|
229
|
+
|
|
230
|
+
[src/Application.ts:249](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L249)
|
|
231
|
+
|
|
232
|
+
___
|
|
233
|
+
|
|
234
|
+
### \_closeSocket
|
|
235
|
+
|
|
236
|
+
▸ `Protected` **_closeSocket**(): `Promise`<`void`\>
|
|
237
|
+
|
|
238
|
+
#### Returns
|
|
239
|
+
|
|
240
|
+
`Promise`<`void`\>
|
|
241
|
+
|
|
242
|
+
#### Defined in
|
|
243
|
+
|
|
244
|
+
[src/Application.ts:255](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L255)
|
|
214
245
|
|
|
215
246
|
___
|
|
216
247
|
|
|
@@ -232,7 +263,7 @@ Subclasses are expected to override this to configure their database setup, if t
|
|
|
232
263
|
|
|
233
264
|
#### Defined in
|
|
234
265
|
|
|
235
|
-
[src/Application.ts:
|
|
266
|
+
[src/Application.ts:381](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L381)
|
|
236
267
|
|
|
237
268
|
___
|
|
238
269
|
|
|
@@ -252,7 +283,7 @@ ___
|
|
|
252
283
|
|
|
253
284
|
#### Defined in
|
|
254
285
|
|
|
255
|
-
[src/Application.ts:165](https://github.com/breautek/storm/blob/
|
|
286
|
+
[src/Application.ts:165](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L165)
|
|
256
287
|
|
|
257
288
|
___
|
|
258
289
|
|
|
@@ -272,7 +303,7 @@ ___
|
|
|
272
303
|
|
|
273
304
|
#### Defined in
|
|
274
305
|
|
|
275
|
-
[src/Application.ts:161](https://github.com/breautek/storm/blob/
|
|
306
|
+
[src/Application.ts:161](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L161)
|
|
276
307
|
|
|
277
308
|
___
|
|
278
309
|
|
|
@@ -286,7 +317,7 @@ ___
|
|
|
286
317
|
|
|
287
318
|
#### Defined in
|
|
288
319
|
|
|
289
|
-
[src/Application.ts:
|
|
320
|
+
[src/Application.ts:385](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L385)
|
|
290
321
|
|
|
291
322
|
___
|
|
292
323
|
|
|
@@ -308,7 +339,7 @@ Invoked once the config has been loaded and ready to be used.
|
|
|
308
339
|
|
|
309
340
|
#### Defined in
|
|
310
341
|
|
|
311
|
-
[src/Application.ts:
|
|
342
|
+
[src/Application.ts:325](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L325)
|
|
312
343
|
|
|
313
344
|
___
|
|
314
345
|
|
|
@@ -324,7 +355,7 @@ Invoked when the application is considered ready for operation.
|
|
|
324
355
|
|
|
325
356
|
#### Defined in
|
|
326
357
|
|
|
327
|
-
[src/Application.ts:
|
|
358
|
+
[src/Application.ts:390](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L390)
|
|
328
359
|
|
|
329
360
|
___
|
|
330
361
|
|
|
@@ -374,7 +405,28 @@ ___
|
|
|
374
405
|
|
|
375
406
|
#### Defined in
|
|
376
407
|
|
|
377
|
-
[src/Application.ts:221](https://github.com/breautek/storm/blob/
|
|
408
|
+
[src/Application.ts:221](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L221)
|
|
409
|
+
|
|
410
|
+
___
|
|
411
|
+
|
|
412
|
+
### attachHandlerInstance
|
|
413
|
+
|
|
414
|
+
▸ **attachHandlerInstance**(`path`, `handler`): `void`
|
|
415
|
+
|
|
416
|
+
#### Parameters
|
|
417
|
+
|
|
418
|
+
| Name | Type |
|
|
419
|
+
| :------ | :------ |
|
|
420
|
+
| `path` | `string` |
|
|
421
|
+
| `handler` | [`Handler`](Handler.Handler-1.md)<[`Application`](Application.Application-1.md)<[`IConfig`](../interfaces/IConfig.IConfig-1.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md), `any`, `any`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> |
|
|
422
|
+
|
|
423
|
+
#### Returns
|
|
424
|
+
|
|
425
|
+
`void`
|
|
426
|
+
|
|
427
|
+
#### Defined in
|
|
428
|
+
|
|
429
|
+
[src/Application.ts:226](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L226)
|
|
378
430
|
|
|
379
431
|
___
|
|
380
432
|
|
|
@@ -388,7 +440,7 @@ ___
|
|
|
388
440
|
|
|
389
441
|
#### Defined in
|
|
390
442
|
|
|
391
|
-
[src/Application.ts:
|
|
443
|
+
[src/Application.ts:245](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L245)
|
|
392
444
|
|
|
393
445
|
___
|
|
394
446
|
|
|
@@ -505,7 +557,7 @@ command line arguments
|
|
|
505
557
|
|
|
506
558
|
#### Defined in
|
|
507
559
|
|
|
508
|
-
[src/Application.ts:
|
|
560
|
+
[src/Application.ts:352](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L352)
|
|
509
561
|
|
|
510
562
|
___
|
|
511
563
|
|
|
@@ -521,7 +573,7 @@ the config object.
|
|
|
521
573
|
|
|
522
574
|
#### Defined in
|
|
523
575
|
|
|
524
|
-
[src/Application.ts:
|
|
576
|
+
[src/Application.ts:309](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L309)
|
|
525
577
|
|
|
526
578
|
___
|
|
527
579
|
|
|
@@ -537,7 +589,7 @@ the database pool. This will need to be casted based on your preferred database
|
|
|
537
589
|
|
|
538
590
|
#### Defined in
|
|
539
591
|
|
|
540
|
-
[src/Application.ts:
|
|
592
|
+
[src/Application.ts:345](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L345)
|
|
541
593
|
|
|
542
594
|
___
|
|
543
595
|
|
|
@@ -551,7 +603,7 @@ ___
|
|
|
551
603
|
|
|
552
604
|
#### Defined in
|
|
553
605
|
|
|
554
|
-
[src/Application.ts:169](https://github.com/breautek/storm/blob/
|
|
606
|
+
[src/Application.ts:169](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L169)
|
|
555
607
|
|
|
556
608
|
___
|
|
557
609
|
|
|
@@ -590,7 +642,7 @@ the application name
|
|
|
590
642
|
|
|
591
643
|
#### Defined in
|
|
592
644
|
|
|
593
|
-
[src/Application.ts:
|
|
645
|
+
[src/Application.ts:298](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L298)
|
|
594
646
|
|
|
595
647
|
___
|
|
596
648
|
|
|
@@ -604,7 +656,7 @@ ___
|
|
|
604
656
|
|
|
605
657
|
#### Defined in
|
|
606
658
|
|
|
607
|
-
[src/Application.ts:173](https://github.com/breautek/storm/blob/
|
|
659
|
+
[src/Application.ts:173](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L173)
|
|
608
660
|
|
|
609
661
|
___
|
|
610
662
|
|
|
@@ -618,7 +670,7 @@ ___
|
|
|
618
670
|
|
|
619
671
|
#### Defined in
|
|
620
672
|
|
|
621
|
-
[src/Application.ts:204](https://github.com/breautek/storm/blob/
|
|
673
|
+
[src/Application.ts:204](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L204)
|
|
622
674
|
|
|
623
675
|
___
|
|
624
676
|
|
|
@@ -634,7 +686,7 @@ The maximum size limit for incoming requests that this service needs to handle.
|
|
|
634
686
|
|
|
635
687
|
#### Defined in
|
|
636
688
|
|
|
637
|
-
[src/Application.ts:211](https://github.com/breautek/storm/blob/
|
|
689
|
+
[src/Application.ts:211](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L211)
|
|
638
690
|
|
|
639
691
|
___
|
|
640
692
|
|
|
@@ -650,7 +702,7 @@ the token manager
|
|
|
650
702
|
|
|
651
703
|
#### Defined in
|
|
652
704
|
|
|
653
|
-
[src/Application.ts:
|
|
705
|
+
[src/Application.ts:338](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L338)
|
|
654
706
|
|
|
655
707
|
___
|
|
656
708
|
|
|
@@ -734,7 +786,7 @@ ___
|
|
|
734
786
|
|
|
735
787
|
#### Defined in
|
|
736
788
|
|
|
737
|
-
[src/Application.ts:
|
|
789
|
+
[src/Application.ts:278](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L278)
|
|
738
790
|
|
|
739
791
|
___
|
|
740
792
|
|
|
@@ -1191,7 +1243,7 @@ Sets the TokenManager to be used for authentication.
|
|
|
1191
1243
|
|
|
1192
1244
|
#### Defined in
|
|
1193
1245
|
|
|
1194
|
-
[src/Application.ts:
|
|
1246
|
+
[src/Application.ts:331](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L331)
|
|
1195
1247
|
|
|
1196
1248
|
___
|
|
1197
1249
|
|
|
@@ -1207,7 +1259,7 @@ true if the Application should bind to an IP address
|
|
|
1207
1259
|
|
|
1208
1260
|
#### Defined in
|
|
1209
1261
|
|
|
1210
|
-
[src/Application.ts:
|
|
1262
|
+
[src/Application.ts:316](https://github.com/breautek/storm/blob/8c3a317/src/Application.ts#L316)
|
|
1211
1263
|
|
|
1212
1264
|
___
|
|
1213
1265
|
|
|
@@ -1396,7 +1448,7 @@ event or that is rejected if the `EventEmitter` emits `'error'` while waiting.
|
|
|
1396
1448
|
The `Promise` will resolve with an array of all the arguments emitted to the
|
|
1397
1449
|
given event.
|
|
1398
1450
|
|
|
1399
|
-
This method is intentionally generic and works with the web platform[EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event
|
|
1451
|
+
This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event
|
|
1400
1452
|
semantics and does not listen to the `'error'` event.
|
|
1401
1453
|
|
|
1402
1454
|
```js
|
|
@@ -27,7 +27,7 @@ for their specific use cases.
|
|
|
27
27
|
|
|
28
28
|
#### Defined in
|
|
29
29
|
|
|
30
|
-
[src/BackendAuthenticationMiddleware.ts:35](https://github.com/breautek/storm/blob/
|
|
30
|
+
[src/BackendAuthenticationMiddleware.ts:35](https://github.com/breautek/storm/blob/8c3a317/src/BackendAuthenticationMiddleware.ts#L35)
|
|
31
31
|
|
|
32
32
|
## Methods
|
|
33
33
|
|
|
@@ -48,4 +48,4 @@ for their specific use cases.
|
|
|
48
48
|
|
|
49
49
|
#### Defined in
|
|
50
50
|
|
|
51
|
-
[src/BackendAuthenticationMiddleware.ts:46](https://github.com/breautek/storm/blob/
|
|
51
|
+
[src/BackendAuthenticationMiddleware.ts:46](https://github.com/breautek/storm/blob/8c3a317/src/BackendAuthenticationMiddleware.ts#L46)
|
|
@@ -48,7 +48,7 @@ communicate with CORS enabled clients.
|
|
|
48
48
|
|
|
49
49
|
#### Defined in
|
|
50
50
|
|
|
51
|
-
[src/CORSMiddleware.ts:39](https://github.com/breautek/storm/blob/
|
|
51
|
+
[src/CORSMiddleware.ts:39](https://github.com/breautek/storm/blob/8c3a317/src/CORSMiddleware.ts#L39)
|
|
52
52
|
|
|
53
53
|
## Methods
|
|
54
54
|
|
|
@@ -73,7 +73,7 @@ communicate with CORS enabled clients.
|
|
|
73
73
|
|
|
74
74
|
#### Defined in
|
|
75
75
|
|
|
76
|
-
[src/CORSMiddleware.ts:75](https://github.com/breautek/storm/blob/
|
|
76
|
+
[src/CORSMiddleware.ts:75](https://github.com/breautek/storm/blob/8c3a317/src/CORSMiddleware.ts#L75)
|
|
77
77
|
|
|
78
78
|
___
|
|
79
79
|
|
|
@@ -98,7 +98,7 @@ ___
|
|
|
98
98
|
|
|
99
99
|
#### Defined in
|
|
100
100
|
|
|
101
|
-
[src/Middleware.ts:27](https://github.com/breautek/storm/blob/
|
|
101
|
+
[src/Middleware.ts:27](https://github.com/breautek/storm/blob/8c3a317/src/Middleware.ts#L27)
|
|
102
102
|
|
|
103
103
|
___
|
|
104
104
|
|
|
@@ -112,7 +112,7 @@ ___
|
|
|
112
112
|
|
|
113
113
|
#### Defined in
|
|
114
114
|
|
|
115
|
-
[src/CORSMiddleware.ts:54](https://github.com/breautek/storm/blob/
|
|
115
|
+
[src/CORSMiddleware.ts:54](https://github.com/breautek/storm/blob/8c3a317/src/CORSMiddleware.ts#L54)
|
|
116
116
|
|
|
117
117
|
___
|
|
118
118
|
|
|
@@ -126,7 +126,7 @@ ___
|
|
|
126
126
|
|
|
127
127
|
#### Defined in
|
|
128
128
|
|
|
129
|
-
[src/CORSMiddleware.ts:64](https://github.com/breautek/storm/blob/
|
|
129
|
+
[src/CORSMiddleware.ts:64](https://github.com/breautek/storm/blob/8c3a317/src/CORSMiddleware.ts#L64)
|
|
130
130
|
|
|
131
131
|
___
|
|
132
132
|
|
|
@@ -142,4 +142,4 @@ Sets the allowed origin. By default,
|
|
|
142
142
|
|
|
143
143
|
#### Defined in
|
|
144
144
|
|
|
145
|
-
[src/CORSMiddleware.ts:50](https://github.com/breautek/storm/blob/
|
|
145
|
+
[src/CORSMiddleware.ts:50](https://github.com/breautek/storm/blob/8c3a317/src/CORSMiddleware.ts#L50)
|
|
@@ -26,10 +26,12 @@
|
|
|
26
26
|
### Methods
|
|
27
27
|
|
|
28
28
|
- [\_addNode](Database.Database-1.md#_addnode)
|
|
29
|
+
- [\_destroy](Database.Database-1.md#_destroy)
|
|
29
30
|
- [\_getConnection](Database.Database-1.md#_getconnection)
|
|
30
31
|
- [\_removeNode](Database.Database-1.md#_removenode)
|
|
31
32
|
- [addMaster](Database.Database-1.md#addmaster)
|
|
32
33
|
- [addSlave](Database.Database-1.md#addslave)
|
|
34
|
+
- [destroy](Database.Database-1.md#destroy)
|
|
33
35
|
- [escape](Database.Database-1.md#escape)
|
|
34
36
|
- [getConnection](Database.Database-1.md#getconnection)
|
|
35
37
|
- [removeMaster](Database.Database-1.md#removemaster)
|
|
@@ -50,7 +52,7 @@
|
|
|
50
52
|
|
|
51
53
|
#### Defined in
|
|
52
54
|
|
|
53
|
-
[src/Database.ts:28](https://github.com/breautek/storm/blob/
|
|
55
|
+
[src/Database.ts:28](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L28)
|
|
54
56
|
|
|
55
57
|
## Methods
|
|
56
58
|
|
|
@@ -71,7 +73,21 @@
|
|
|
71
73
|
|
|
72
74
|
#### Defined in
|
|
73
75
|
|
|
74
|
-
[src/Database.ts:
|
|
76
|
+
[src/Database.ts:83](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L83)
|
|
77
|
+
|
|
78
|
+
___
|
|
79
|
+
|
|
80
|
+
### \_destroy
|
|
81
|
+
|
|
82
|
+
▸ `Protected` `Abstract` **_destroy**(): `Promise`<`void`\>
|
|
83
|
+
|
|
84
|
+
#### Returns
|
|
85
|
+
|
|
86
|
+
`Promise`<`void`\>
|
|
87
|
+
|
|
88
|
+
#### Defined in
|
|
89
|
+
|
|
90
|
+
[src/Database.ts:82](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L82)
|
|
75
91
|
|
|
76
92
|
___
|
|
77
93
|
|
|
@@ -92,7 +108,7 @@ ___
|
|
|
92
108
|
|
|
93
109
|
#### Defined in
|
|
94
110
|
|
|
95
|
-
[src/Database.ts:
|
|
111
|
+
[src/Database.ts:85](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L85)
|
|
96
112
|
|
|
97
113
|
___
|
|
98
114
|
|
|
@@ -112,7 +128,7 @@ ___
|
|
|
112
128
|
|
|
113
129
|
#### Defined in
|
|
114
130
|
|
|
115
|
-
[src/Database.ts:
|
|
131
|
+
[src/Database.ts:84](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L84)
|
|
116
132
|
|
|
117
133
|
___
|
|
118
134
|
|
|
@@ -132,7 +148,7 @@ ___
|
|
|
132
148
|
|
|
133
149
|
#### Defined in
|
|
134
150
|
|
|
135
|
-
[src/Database.ts:32](https://github.com/breautek/storm/blob/
|
|
151
|
+
[src/Database.ts:32](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L32)
|
|
136
152
|
|
|
137
153
|
___
|
|
138
154
|
|
|
@@ -153,7 +169,21 @@ ___
|
|
|
153
169
|
|
|
154
170
|
#### Defined in
|
|
155
171
|
|
|
156
|
-
[src/Database.ts:46](https://github.com/breautek/storm/blob/
|
|
172
|
+
[src/Database.ts:46](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L46)
|
|
173
|
+
|
|
174
|
+
___
|
|
175
|
+
|
|
176
|
+
### destroy
|
|
177
|
+
|
|
178
|
+
▸ **destroy**(): `Promise`<`void`\>
|
|
179
|
+
|
|
180
|
+
#### Returns
|
|
181
|
+
|
|
182
|
+
`Promise`<`void`\>
|
|
183
|
+
|
|
184
|
+
#### Defined in
|
|
185
|
+
|
|
186
|
+
[src/Database.ts:78](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L78)
|
|
157
187
|
|
|
158
188
|
___
|
|
159
189
|
|
|
@@ -173,7 +203,7 @@ ___
|
|
|
173
203
|
|
|
174
204
|
#### Defined in
|
|
175
205
|
|
|
176
|
-
[src/Database.ts:
|
|
206
|
+
[src/Database.ts:86](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L86)
|
|
177
207
|
|
|
178
208
|
___
|
|
179
209
|
|
|
@@ -194,7 +224,7 @@ ___
|
|
|
194
224
|
|
|
195
225
|
#### Defined in
|
|
196
226
|
|
|
197
|
-
[src/Database.ts:65](https://github.com/breautek/storm/blob/
|
|
227
|
+
[src/Database.ts:65](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L65)
|
|
198
228
|
|
|
199
229
|
___
|
|
200
230
|
|
|
@@ -208,7 +238,7 @@ ___
|
|
|
208
238
|
|
|
209
239
|
#### Defined in
|
|
210
240
|
|
|
211
|
-
[src/Database.ts:41](https://github.com/breautek/storm/blob/
|
|
241
|
+
[src/Database.ts:41](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L41)
|
|
212
242
|
|
|
213
243
|
___
|
|
214
244
|
|
|
@@ -228,4 +258,4 @@ ___
|
|
|
228
258
|
|
|
229
259
|
#### Defined in
|
|
230
260
|
|
|
231
|
-
[src/Database.ts:55](https://github.com/breautek/storm/blob/
|
|
261
|
+
[src/Database.ts:55](https://github.com/breautek/storm/blob/8c3a317/src/Database.ts#L55)
|
|
@@ -75,7 +75,7 @@ Do not call `new Database` directly. Use `Database.getConnection` to create a `D
|
|
|
75
75
|
|
|
76
76
|
#### Defined in
|
|
77
77
|
|
|
78
|
-
[src/DatabaseConnection.ts:44](https://github.com/breautek/storm/blob/
|
|
78
|
+
[src/DatabaseConnection.ts:44](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L44)
|
|
79
79
|
|
|
80
80
|
## Methods
|
|
81
81
|
|
|
@@ -102,7 +102,7 @@ Promise<void>
|
|
|
102
102
|
|
|
103
103
|
#### Defined in
|
|
104
104
|
|
|
105
|
-
[src/DatabaseConnection.ts:239](https://github.com/breautek/storm/blob/
|
|
105
|
+
[src/DatabaseConnection.ts:239](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L239)
|
|
106
106
|
|
|
107
107
|
___
|
|
108
108
|
|
|
@@ -135,7 +135,7 @@ Promise
|
|
|
135
135
|
|
|
136
136
|
#### Defined in
|
|
137
137
|
|
|
138
|
-
[src/DatabaseConnection.ts:250](https://github.com/breautek/storm/blob/
|
|
138
|
+
[src/DatabaseConnection.ts:250](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L250)
|
|
139
139
|
|
|
140
140
|
___
|
|
141
141
|
|
|
@@ -162,7 +162,7 @@ but returns a `Readable` stream instead.
|
|
|
162
162
|
|
|
163
163
|
#### Defined in
|
|
164
164
|
|
|
165
|
-
[src/DatabaseConnection.ts:262](https://github.com/breautek/storm/blob/
|
|
165
|
+
[src/DatabaseConnection.ts:262](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L262)
|
|
166
166
|
|
|
167
167
|
___
|
|
168
168
|
|
|
@@ -194,7 +194,7 @@ Promise<void>
|
|
|
194
194
|
|
|
195
195
|
#### Defined in
|
|
196
196
|
|
|
197
|
-
[src/DatabaseConnection.ts:169](https://github.com/breautek/storm/blob/
|
|
197
|
+
[src/DatabaseConnection.ts:169](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L169)
|
|
198
198
|
|
|
199
199
|
___
|
|
200
200
|
|
|
@@ -220,7 +220,7 @@ Promise<void>
|
|
|
220
220
|
|
|
221
221
|
#### Defined in
|
|
222
222
|
|
|
223
|
-
[src/DatabaseConnection.ts:220](https://github.com/breautek/storm/blob/
|
|
223
|
+
[src/DatabaseConnection.ts:220](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L220)
|
|
224
224
|
|
|
225
225
|
___
|
|
226
226
|
|
|
@@ -248,7 +248,7 @@ Promise<void>
|
|
|
248
248
|
|
|
249
249
|
#### Defined in
|
|
250
250
|
|
|
251
|
-
[src/DatabaseConnection.ts:211](https://github.com/breautek/storm/blob/
|
|
251
|
+
[src/DatabaseConnection.ts:211](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L211)
|
|
252
252
|
|
|
253
253
|
___
|
|
254
254
|
|
|
@@ -270,7 +270,7 @@ any
|
|
|
270
270
|
|
|
271
271
|
#### Defined in
|
|
272
272
|
|
|
273
|
-
[src/DatabaseConnection.ts:91](https://github.com/breautek/storm/blob/
|
|
273
|
+
[src/DatabaseConnection.ts:91](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L91)
|
|
274
274
|
|
|
275
275
|
___
|
|
276
276
|
|
|
@@ -293,7 +293,7 @@ string - A stacktrace
|
|
|
293
293
|
|
|
294
294
|
#### Defined in
|
|
295
295
|
|
|
296
|
-
[src/DatabaseConnection.ts:73](https://github.com/breautek/storm/blob/
|
|
296
|
+
[src/DatabaseConnection.ts:73](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L73)
|
|
297
297
|
|
|
298
298
|
___
|
|
299
299
|
|
|
@@ -315,7 +315,7 @@ number in milliseconds
|
|
|
315
315
|
|
|
316
316
|
#### Defined in
|
|
317
317
|
|
|
318
|
-
[src/DatabaseConnection.ts:121](https://github.com/breautek/storm/blob/
|
|
318
|
+
[src/DatabaseConnection.ts:121](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L121)
|
|
319
319
|
|
|
320
320
|
___
|
|
321
321
|
|
|
@@ -335,7 +335,7 @@ Returns true if the connection has been closed.
|
|
|
335
335
|
|
|
336
336
|
#### Defined in
|
|
337
337
|
|
|
338
|
-
[src/DatabaseConnection.ts:182](https://github.com/breautek/storm/blob/
|
|
338
|
+
[src/DatabaseConnection.ts:182](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L182)
|
|
339
339
|
|
|
340
340
|
___
|
|
341
341
|
|
|
@@ -358,7 +358,7 @@ boolean
|
|
|
358
358
|
|
|
359
359
|
#### Defined in
|
|
360
360
|
|
|
361
|
-
[src/DatabaseConnection.ts:100](https://github.com/breautek/storm/blob/
|
|
361
|
+
[src/DatabaseConnection.ts:100](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L100)
|
|
362
362
|
|
|
363
363
|
___
|
|
364
364
|
|
|
@@ -382,7 +382,7 @@ boolean
|
|
|
382
382
|
|
|
383
383
|
#### Defined in
|
|
384
384
|
|
|
385
|
-
[src/DatabaseConnection.ts:201](https://github.com/breautek/storm/blob/
|
|
385
|
+
[src/DatabaseConnection.ts:201](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L201)
|
|
386
386
|
|
|
387
387
|
___
|
|
388
388
|
|
|
@@ -418,7 +418,7 @@ Promise<TQueryResult>
|
|
|
418
418
|
|
|
419
419
|
#### Defined in
|
|
420
420
|
|
|
421
|
-
[src/DatabaseConnection.ts:132](https://github.com/breautek/storm/blob/
|
|
421
|
+
[src/DatabaseConnection.ts:132](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L132)
|
|
422
422
|
|
|
423
423
|
___
|
|
424
424
|
|
|
@@ -444,7 +444,7 @@ Promise<void>
|
|
|
444
444
|
|
|
445
445
|
#### Defined in
|
|
446
446
|
|
|
447
|
-
[src/DatabaseConnection.ts:229](https://github.com/breautek/storm/blob/
|
|
447
|
+
[src/DatabaseConnection.ts:229](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L229)
|
|
448
448
|
|
|
449
449
|
___
|
|
450
450
|
|
|
@@ -468,7 +468,7 @@ ___
|
|
|
468
468
|
|
|
469
469
|
#### Defined in
|
|
470
470
|
|
|
471
|
-
[src/DatabaseConnection.ts:64](https://github.com/breautek/storm/blob/
|
|
471
|
+
[src/DatabaseConnection.ts:64](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L64)
|
|
472
472
|
|
|
473
473
|
___
|
|
474
474
|
|
|
@@ -494,7 +494,7 @@ Sets the timeout of this connectino
|
|
|
494
494
|
|
|
495
495
|
#### Defined in
|
|
496
496
|
|
|
497
|
-
[src/DatabaseConnection.ts:109](https://github.com/breautek/storm/blob/
|
|
497
|
+
[src/DatabaseConnection.ts:109](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L109)
|
|
498
498
|
|
|
499
499
|
___
|
|
500
500
|
|
|
@@ -520,7 +520,7 @@ Promise<void>
|
|
|
520
520
|
|
|
521
521
|
#### Defined in
|
|
522
522
|
|
|
523
|
-
[src/DatabaseConnection.ts:193](https://github.com/breautek/storm/blob/
|
|
523
|
+
[src/DatabaseConnection.ts:193](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L193)
|
|
524
524
|
|
|
525
525
|
___
|
|
526
526
|
|
|
@@ -547,4 +547,4 @@ Readable
|
|
|
547
547
|
|
|
548
548
|
#### Defined in
|
|
549
549
|
|
|
550
|
-
[src/DatabaseConnection.ts:152](https://github.com/breautek/storm/blob/
|
|
550
|
+
[src/DatabaseConnection.ts:152](https://github.com/breautek/storm/blob/8c3a317/src/DatabaseConnection.ts#L152)
|