@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
|
@@ -78,6 +78,7 @@ Main entry point for the Application. Should be extended and have the abstract m
|
|
|
78
78
|
- [listenerCount](Application.md#listenercount-1)
|
|
79
79
|
- [on](Application.md#on-1)
|
|
80
80
|
- [once](Application.md#once-1)
|
|
81
|
+
- [setMaxListeners](Application.md#setmaxlisteners-1)
|
|
81
82
|
|
|
82
83
|
## Constructors
|
|
83
84
|
|
|
@@ -107,7 +108,7 @@ EventEmitter.constructor
|
|
|
107
108
|
|
|
108
109
|
#### Defined in
|
|
109
110
|
|
|
110
|
-
[src/Application.ts:64](https://github.com/breautek/storm/blob/
|
|
111
|
+
[src/Application.ts:64](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L64)
|
|
111
112
|
|
|
112
113
|
## Properties
|
|
113
114
|
|
|
@@ -121,7 +122,7 @@ EventEmitter.captureRejectionSymbol
|
|
|
121
122
|
|
|
122
123
|
#### Defined in
|
|
123
124
|
|
|
124
|
-
node_modules/@types/node/events.d.ts:
|
|
125
|
+
node_modules/@types/node/ts4.8/events.d.ts:328
|
|
125
126
|
|
|
126
127
|
___
|
|
127
128
|
|
|
@@ -137,7 +138,7 @@ EventEmitter.captureRejections
|
|
|
137
138
|
|
|
138
139
|
#### Defined in
|
|
139
140
|
|
|
140
|
-
node_modules/@types/node/events.d.ts:
|
|
141
|
+
node_modules/@types/node/ts4.8/events.d.ts:333
|
|
141
142
|
|
|
142
143
|
___
|
|
143
144
|
|
|
@@ -151,7 +152,7 @@ EventEmitter.defaultMaxListeners
|
|
|
151
152
|
|
|
152
153
|
#### Defined in
|
|
153
154
|
|
|
154
|
-
node_modules/@types/node/events.d.ts:
|
|
155
|
+
node_modules/@types/node/ts4.8/events.d.ts:334
|
|
155
156
|
|
|
156
157
|
___
|
|
157
158
|
|
|
@@ -173,7 +174,7 @@ EventEmitter.errorMonitor
|
|
|
173
174
|
|
|
174
175
|
#### Defined in
|
|
175
176
|
|
|
176
|
-
node_modules/@types/node/events.d.ts:
|
|
177
|
+
node_modules/@types/node/ts4.8/events.d.ts:327
|
|
177
178
|
|
|
178
179
|
## Methods
|
|
179
180
|
|
|
@@ -191,7 +192,7 @@ Promise<void>
|
|
|
191
192
|
|
|
192
193
|
#### Defined in
|
|
193
194
|
|
|
194
|
-
[src/Application.ts:272](https://github.com/breautek/storm/blob/
|
|
195
|
+
[src/Application.ts:272](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L272)
|
|
195
196
|
|
|
196
197
|
___
|
|
197
198
|
|
|
@@ -211,7 +212,7 @@ ___
|
|
|
211
212
|
|
|
212
213
|
#### Defined in
|
|
213
214
|
|
|
214
|
-
[src/Application.ts:202](https://github.com/breautek/storm/blob/
|
|
215
|
+
[src/Application.ts:202](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L202)
|
|
215
216
|
|
|
216
217
|
___
|
|
217
218
|
|
|
@@ -225,7 +226,7 @@ ___
|
|
|
225
226
|
|
|
226
227
|
#### Defined in
|
|
227
228
|
|
|
228
|
-
[src/Application.ts:249](https://github.com/breautek/storm/blob/
|
|
229
|
+
[src/Application.ts:249](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L249)
|
|
229
230
|
|
|
230
231
|
___
|
|
231
232
|
|
|
@@ -239,7 +240,7 @@ ___
|
|
|
239
240
|
|
|
240
241
|
#### Defined in
|
|
241
242
|
|
|
242
|
-
[src/Application.ts:255](https://github.com/breautek/storm/blob/
|
|
243
|
+
[src/Application.ts:255](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L255)
|
|
243
244
|
|
|
244
245
|
___
|
|
245
246
|
|
|
@@ -261,7 +262,7 @@ Subclasses are expected to override this to configure their database setup, if t
|
|
|
261
262
|
|
|
262
263
|
#### Defined in
|
|
263
264
|
|
|
264
|
-
[src/Application.ts:381](https://github.com/breautek/storm/blob/
|
|
265
|
+
[src/Application.ts:381](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L381)
|
|
265
266
|
|
|
266
267
|
___
|
|
267
268
|
|
|
@@ -281,7 +282,7 @@ ___
|
|
|
281
282
|
|
|
282
283
|
#### Defined in
|
|
283
284
|
|
|
284
|
-
[src/Application.ts:165](https://github.com/breautek/storm/blob/
|
|
285
|
+
[src/Application.ts:165](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L165)
|
|
285
286
|
|
|
286
287
|
___
|
|
287
288
|
|
|
@@ -301,7 +302,7 @@ ___
|
|
|
301
302
|
|
|
302
303
|
#### Defined in
|
|
303
304
|
|
|
304
|
-
[src/Application.ts:161](https://github.com/breautek/storm/blob/
|
|
305
|
+
[src/Application.ts:161](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L161)
|
|
305
306
|
|
|
306
307
|
___
|
|
307
308
|
|
|
@@ -315,7 +316,7 @@ ___
|
|
|
315
316
|
|
|
316
317
|
#### Defined in
|
|
317
318
|
|
|
318
|
-
[src/Application.ts:385](https://github.com/breautek/storm/blob/
|
|
319
|
+
[src/Application.ts:385](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L385)
|
|
319
320
|
|
|
320
321
|
___
|
|
321
322
|
|
|
@@ -337,7 +338,7 @@ Invoked once the config has been loaded and ready to be used.
|
|
|
337
338
|
|
|
338
339
|
#### Defined in
|
|
339
340
|
|
|
340
|
-
[src/Application.ts:325](https://github.com/breautek/storm/blob/
|
|
341
|
+
[src/Application.ts:325](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L325)
|
|
341
342
|
|
|
342
343
|
___
|
|
343
344
|
|
|
@@ -353,7 +354,7 @@ Invoked when the application is considered ready for operation.
|
|
|
353
354
|
|
|
354
355
|
#### Defined in
|
|
355
356
|
|
|
356
|
-
[src/Application.ts:390](https://github.com/breautek/storm/blob/
|
|
357
|
+
[src/Application.ts:390](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L390)
|
|
357
358
|
|
|
358
359
|
___
|
|
359
360
|
|
|
@@ -363,7 +364,9 @@ ___
|
|
|
363
364
|
|
|
364
365
|
Alias for `emitter.on(eventName, listener)`.
|
|
365
366
|
|
|
366
|
-
**`
|
|
367
|
+
**`Since`**
|
|
368
|
+
|
|
369
|
+
v0.1.26
|
|
367
370
|
|
|
368
371
|
#### Parameters
|
|
369
372
|
|
|
@@ -382,7 +385,7 @@ EventEmitter.addListener
|
|
|
382
385
|
|
|
383
386
|
#### Defined in
|
|
384
387
|
|
|
385
|
-
node_modules/@types/node/events.d.ts:
|
|
388
|
+
node_modules/@types/node/ts4.8/events.d.ts:354
|
|
386
389
|
|
|
387
390
|
___
|
|
388
391
|
|
|
@@ -403,7 +406,7 @@ ___
|
|
|
403
406
|
|
|
404
407
|
#### Defined in
|
|
405
408
|
|
|
406
|
-
[src/Application.ts:221](https://github.com/breautek/storm/blob/
|
|
409
|
+
[src/Application.ts:221](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L221)
|
|
407
410
|
|
|
408
411
|
___
|
|
409
412
|
|
|
@@ -424,7 +427,7 @@ ___
|
|
|
424
427
|
|
|
425
428
|
#### Defined in
|
|
426
429
|
|
|
427
|
-
[src/Application.ts:226](https://github.com/breautek/storm/blob/
|
|
430
|
+
[src/Application.ts:226](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L226)
|
|
428
431
|
|
|
429
432
|
___
|
|
430
433
|
|
|
@@ -438,7 +441,7 @@ ___
|
|
|
438
441
|
|
|
439
442
|
#### Defined in
|
|
440
443
|
|
|
441
|
-
[src/Application.ts:245](https://github.com/breautek/storm/blob/
|
|
444
|
+
[src/Application.ts:245](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L245)
|
|
442
445
|
|
|
443
446
|
___
|
|
444
447
|
|
|
@@ -484,7 +487,9 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
|
|
|
484
487
|
// event with parameters 1, 2, 3, 4, 5 in third listener
|
|
485
488
|
```
|
|
486
489
|
|
|
487
|
-
**`
|
|
490
|
+
**`Since`**
|
|
491
|
+
|
|
492
|
+
v0.1.26
|
|
488
493
|
|
|
489
494
|
#### Parameters
|
|
490
495
|
|
|
@@ -503,7 +508,7 @@ EventEmitter.emit
|
|
|
503
508
|
|
|
504
509
|
#### Defined in
|
|
505
510
|
|
|
506
|
-
node_modules/@types/node/events.d.ts:
|
|
511
|
+
node_modules/@types/node/ts4.8/events.d.ts:610
|
|
507
512
|
|
|
508
513
|
___
|
|
509
514
|
|
|
@@ -527,7 +532,9 @@ console.log(myEE.eventNames());
|
|
|
527
532
|
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
|
|
528
533
|
```
|
|
529
534
|
|
|
530
|
-
**`
|
|
535
|
+
**`Since`**
|
|
536
|
+
|
|
537
|
+
v6.0.0
|
|
531
538
|
|
|
532
539
|
#### Returns
|
|
533
540
|
|
|
@@ -539,7 +546,7 @@ EventEmitter.eventNames
|
|
|
539
546
|
|
|
540
547
|
#### Defined in
|
|
541
548
|
|
|
542
|
-
node_modules/@types/node/events.d.ts:
|
|
549
|
+
node_modules/@types/node/ts4.8/events.d.ts:669
|
|
543
550
|
|
|
544
551
|
___
|
|
545
552
|
|
|
@@ -555,7 +562,7 @@ command line arguments
|
|
|
555
562
|
|
|
556
563
|
#### Defined in
|
|
557
564
|
|
|
558
|
-
[src/Application.ts:352](https://github.com/breautek/storm/blob/
|
|
565
|
+
[src/Application.ts:352](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L352)
|
|
559
566
|
|
|
560
567
|
___
|
|
561
568
|
|
|
@@ -571,7 +578,7 @@ the config object.
|
|
|
571
578
|
|
|
572
579
|
#### Defined in
|
|
573
580
|
|
|
574
|
-
[src/Application.ts:309](https://github.com/breautek/storm/blob/
|
|
581
|
+
[src/Application.ts:309](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L309)
|
|
575
582
|
|
|
576
583
|
___
|
|
577
584
|
|
|
@@ -587,7 +594,7 @@ the database pool. This will need to be casted based on your preferred database
|
|
|
587
594
|
|
|
588
595
|
#### Defined in
|
|
589
596
|
|
|
590
|
-
[src/Application.ts:345](https://github.com/breautek/storm/blob/
|
|
597
|
+
[src/Application.ts:345](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L345)
|
|
591
598
|
|
|
592
599
|
___
|
|
593
600
|
|
|
@@ -601,7 +608,7 @@ ___
|
|
|
601
608
|
|
|
602
609
|
#### Defined in
|
|
603
610
|
|
|
604
|
-
[src/Application.ts:169](https://github.com/breautek/storm/blob/
|
|
611
|
+
[src/Application.ts:169](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L169)
|
|
605
612
|
|
|
606
613
|
___
|
|
607
614
|
|
|
@@ -612,7 +619,9 @@ ___
|
|
|
612
619
|
Returns the current max listener value for the `EventEmitter` which is either
|
|
613
620
|
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](Application.md#defaultmaxlisteners).
|
|
614
621
|
|
|
615
|
-
**`
|
|
622
|
+
**`Since`**
|
|
623
|
+
|
|
624
|
+
v1.0.0
|
|
616
625
|
|
|
617
626
|
#### Returns
|
|
618
627
|
|
|
@@ -624,7 +633,7 @@ EventEmitter.getMaxListeners
|
|
|
624
633
|
|
|
625
634
|
#### Defined in
|
|
626
635
|
|
|
627
|
-
node_modules/@types/node/events.d.ts:
|
|
636
|
+
node_modules/@types/node/ts4.8/events.d.ts:526
|
|
628
637
|
|
|
629
638
|
___
|
|
630
639
|
|
|
@@ -640,7 +649,7 @@ the application name
|
|
|
640
649
|
|
|
641
650
|
#### Defined in
|
|
642
651
|
|
|
643
|
-
[src/Application.ts:298](https://github.com/breautek/storm/blob/
|
|
652
|
+
[src/Application.ts:298](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L298)
|
|
644
653
|
|
|
645
654
|
___
|
|
646
655
|
|
|
@@ -654,7 +663,7 @@ ___
|
|
|
654
663
|
|
|
655
664
|
#### Defined in
|
|
656
665
|
|
|
657
|
-
[src/Application.ts:173](https://github.com/breautek/storm/blob/
|
|
666
|
+
[src/Application.ts:173](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L173)
|
|
658
667
|
|
|
659
668
|
___
|
|
660
669
|
|
|
@@ -668,7 +677,7 @@ ___
|
|
|
668
677
|
|
|
669
678
|
#### Defined in
|
|
670
679
|
|
|
671
|
-
[src/Application.ts:204](https://github.com/breautek/storm/blob/
|
|
680
|
+
[src/Application.ts:204](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L204)
|
|
672
681
|
|
|
673
682
|
___
|
|
674
683
|
|
|
@@ -684,7 +693,7 @@ The maximum size limit for incoming requests that this service needs to handle.
|
|
|
684
693
|
|
|
685
694
|
#### Defined in
|
|
686
695
|
|
|
687
|
-
[src/Application.ts:211](https://github.com/breautek/storm/blob/
|
|
696
|
+
[src/Application.ts:211](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L211)
|
|
688
697
|
|
|
689
698
|
___
|
|
690
699
|
|
|
@@ -700,7 +709,7 @@ the token manager
|
|
|
700
709
|
|
|
701
710
|
#### Defined in
|
|
702
711
|
|
|
703
|
-
[src/Application.ts:338](https://github.com/breautek/storm/blob/
|
|
712
|
+
[src/Application.ts:338](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L338)
|
|
704
713
|
|
|
705
714
|
___
|
|
706
715
|
|
|
@@ -710,7 +719,9 @@ ___
|
|
|
710
719
|
|
|
711
720
|
Returns the number of listeners listening to the event named `eventName`.
|
|
712
721
|
|
|
713
|
-
**`
|
|
722
|
+
**`Since`**
|
|
723
|
+
|
|
724
|
+
v3.2.0
|
|
714
725
|
|
|
715
726
|
#### Parameters
|
|
716
727
|
|
|
@@ -728,7 +739,7 @@ EventEmitter.listenerCount
|
|
|
728
739
|
|
|
729
740
|
#### Defined in
|
|
730
741
|
|
|
731
|
-
node_modules/@types/node/events.d.ts:
|
|
742
|
+
node_modules/@types/node/ts4.8/events.d.ts:616
|
|
732
743
|
|
|
733
744
|
___
|
|
734
745
|
|
|
@@ -746,7 +757,9 @@ console.log(util.inspect(server.listeners('connection')));
|
|
|
746
757
|
// Prints: [ [Function] ]
|
|
747
758
|
```
|
|
748
759
|
|
|
749
|
-
**`
|
|
760
|
+
**`Since`**
|
|
761
|
+
|
|
762
|
+
v0.1.26
|
|
750
763
|
|
|
751
764
|
#### Parameters
|
|
752
765
|
|
|
@@ -764,7 +777,7 @@ EventEmitter.listeners
|
|
|
764
777
|
|
|
765
778
|
#### Defined in
|
|
766
779
|
|
|
767
|
-
node_modules/@types/node/events.d.ts:
|
|
780
|
+
node_modules/@types/node/ts4.8/events.d.ts:539
|
|
768
781
|
|
|
769
782
|
___
|
|
770
783
|
|
|
@@ -784,7 +797,7 @@ ___
|
|
|
784
797
|
|
|
785
798
|
#### Defined in
|
|
786
799
|
|
|
787
|
-
[src/Application.ts:278](https://github.com/breautek/storm/blob/
|
|
800
|
+
[src/Application.ts:278](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L278)
|
|
788
801
|
|
|
789
802
|
___
|
|
790
803
|
|
|
@@ -794,7 +807,9 @@ ___
|
|
|
794
807
|
|
|
795
808
|
Alias for `emitter.removeListener()`.
|
|
796
809
|
|
|
797
|
-
**`
|
|
810
|
+
**`Since`**
|
|
811
|
+
|
|
812
|
+
v10.0.0
|
|
798
813
|
|
|
799
814
|
#### Parameters
|
|
800
815
|
|
|
@@ -813,7 +828,7 @@ EventEmitter.off
|
|
|
813
828
|
|
|
814
829
|
#### Defined in
|
|
815
830
|
|
|
816
|
-
node_modules/@types/node/events.d.ts:
|
|
831
|
+
node_modules/@types/node/ts4.8/events.d.ts:499
|
|
817
832
|
|
|
818
833
|
___
|
|
819
834
|
|
|
@@ -847,7 +862,9 @@ myEE.emit('foo');
|
|
|
847
862
|
// a
|
|
848
863
|
```
|
|
849
864
|
|
|
850
|
-
**`
|
|
865
|
+
**`Since`**
|
|
866
|
+
|
|
867
|
+
v0.1.101
|
|
851
868
|
|
|
852
869
|
#### Parameters
|
|
853
870
|
|
|
@@ -866,7 +883,7 @@ EventEmitter.on
|
|
|
866
883
|
|
|
867
884
|
#### Defined in
|
|
868
885
|
|
|
869
|
-
node_modules/@types/node/events.d.ts:
|
|
886
|
+
node_modules/@types/node/ts4.8/events.d.ts:385
|
|
870
887
|
|
|
871
888
|
___
|
|
872
889
|
|
|
@@ -898,7 +915,9 @@ myEE.emit('foo');
|
|
|
898
915
|
// a
|
|
899
916
|
```
|
|
900
917
|
|
|
901
|
-
**`
|
|
918
|
+
**`Since`**
|
|
919
|
+
|
|
920
|
+
v0.3.0
|
|
902
921
|
|
|
903
922
|
#### Parameters
|
|
904
923
|
|
|
@@ -917,7 +936,7 @@ EventEmitter.once
|
|
|
917
936
|
|
|
918
937
|
#### Defined in
|
|
919
938
|
|
|
920
|
-
node_modules/@types/node/events.d.ts:
|
|
939
|
+
node_modules/@types/node/ts4.8/events.d.ts:414
|
|
921
940
|
|
|
922
941
|
___
|
|
923
942
|
|
|
@@ -938,7 +957,9 @@ server.prependListener('connection', (stream) => {
|
|
|
938
957
|
|
|
939
958
|
Returns a reference to the `EventEmitter`, so that calls can be chained.
|
|
940
959
|
|
|
941
|
-
**`
|
|
960
|
+
**`Since`**
|
|
961
|
+
|
|
962
|
+
v6.0.0
|
|
942
963
|
|
|
943
964
|
#### Parameters
|
|
944
965
|
|
|
@@ -957,7 +978,7 @@ EventEmitter.prependListener
|
|
|
957
978
|
|
|
958
979
|
#### Defined in
|
|
959
980
|
|
|
960
|
-
node_modules/@types/node/events.d.ts:
|
|
981
|
+
node_modules/@types/node/ts4.8/events.d.ts:634
|
|
961
982
|
|
|
962
983
|
___
|
|
963
984
|
|
|
@@ -965,7 +986,7 @@ ___
|
|
|
965
986
|
|
|
966
987
|
▸ **prependOnceListener**(`eventName`, `listener`): [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
|
|
967
988
|
|
|
968
|
-
Adds a **one-time**`listener` function for the event named `eventName` to
|
|
989
|
+
Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this
|
|
969
990
|
listener is removed, and then invoked.
|
|
970
991
|
|
|
971
992
|
```js
|
|
@@ -976,7 +997,9 @@ server.prependOnceListener('connection', (stream) => {
|
|
|
976
997
|
|
|
977
998
|
Returns a reference to the `EventEmitter`, so that calls can be chained.
|
|
978
999
|
|
|
979
|
-
**`
|
|
1000
|
+
**`Since`**
|
|
1001
|
+
|
|
1002
|
+
v6.0.0
|
|
980
1003
|
|
|
981
1004
|
#### Parameters
|
|
982
1005
|
|
|
@@ -995,7 +1018,7 @@ EventEmitter.prependOnceListener
|
|
|
995
1018
|
|
|
996
1019
|
#### Defined in
|
|
997
1020
|
|
|
998
|
-
node_modules/@types/node/events.d.ts:
|
|
1021
|
+
node_modules/@types/node/ts4.8/events.d.ts:650
|
|
999
1022
|
|
|
1000
1023
|
___
|
|
1001
1024
|
|
|
@@ -1030,7 +1053,9 @@ newListeners[0]();
|
|
|
1030
1053
|
emitter.emit('log');
|
|
1031
1054
|
```
|
|
1032
1055
|
|
|
1033
|
-
**`
|
|
1056
|
+
**`Since`**
|
|
1057
|
+
|
|
1058
|
+
v9.4.0
|
|
1034
1059
|
|
|
1035
1060
|
#### Parameters
|
|
1036
1061
|
|
|
@@ -1048,7 +1073,7 @@ EventEmitter.rawListeners
|
|
|
1048
1073
|
|
|
1049
1074
|
#### Defined in
|
|
1050
1075
|
|
|
1051
|
-
node_modules/@types/node/events.d.ts:
|
|
1076
|
+
node_modules/@types/node/ts4.8/events.d.ts:569
|
|
1052
1077
|
|
|
1053
1078
|
___
|
|
1054
1079
|
|
|
@@ -1064,7 +1089,9 @@ component or module (e.g. sockets or file streams).
|
|
|
1064
1089
|
|
|
1065
1090
|
Returns a reference to the `EventEmitter`, so that calls can be chained.
|
|
1066
1091
|
|
|
1067
|
-
**`
|
|
1092
|
+
**`Since`**
|
|
1093
|
+
|
|
1094
|
+
v0.1.26
|
|
1068
1095
|
|
|
1069
1096
|
#### Parameters
|
|
1070
1097
|
|
|
@@ -1082,7 +1109,7 @@ EventEmitter.removeAllListeners
|
|
|
1082
1109
|
|
|
1083
1110
|
#### Defined in
|
|
1084
1111
|
|
|
1085
|
-
node_modules/@types/node/events.d.ts:
|
|
1112
|
+
node_modules/@types/node/ts4.8/events.d.ts:510
|
|
1086
1113
|
|
|
1087
1114
|
___
|
|
1088
1115
|
|
|
@@ -1107,8 +1134,8 @@ listener array for the specified `eventName`, then `removeListener()` must be
|
|
|
1107
1134
|
called multiple times to remove each instance.
|
|
1108
1135
|
|
|
1109
1136
|
Once an event is emitted, all listeners attached to it at the
|
|
1110
|
-
time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting
|
|
1111
|
-
not remove them from`emit()` in progress. Subsequent events behave as expected.
|
|
1137
|
+
time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution
|
|
1138
|
+
will not remove them from`emit()` in progress. Subsequent events behave as expected.
|
|
1112
1139
|
|
|
1113
1140
|
```js
|
|
1114
1141
|
const myEmitter = new MyEmitter();
|
|
@@ -1167,7 +1194,9 @@ ee.emit('ping');
|
|
|
1167
1194
|
|
|
1168
1195
|
Returns a reference to the `EventEmitter`, so that calls can be chained.
|
|
1169
1196
|
|
|
1170
|
-
**`
|
|
1197
|
+
**`Since`**
|
|
1198
|
+
|
|
1199
|
+
v0.1.26
|
|
1171
1200
|
|
|
1172
1201
|
#### Parameters
|
|
1173
1202
|
|
|
@@ -1186,7 +1215,7 @@ EventEmitter.removeListener
|
|
|
1186
1215
|
|
|
1187
1216
|
#### Defined in
|
|
1188
1217
|
|
|
1189
|
-
node_modules/@types/node/events.d.ts:
|
|
1218
|
+
node_modules/@types/node/ts4.8/events.d.ts:494
|
|
1190
1219
|
|
|
1191
1220
|
___
|
|
1192
1221
|
|
|
@@ -1201,7 +1230,9 @@ modified for this specific `EventEmitter` instance. The value can be set to`Infi
|
|
|
1201
1230
|
|
|
1202
1231
|
Returns a reference to the `EventEmitter`, so that calls can be chained.
|
|
1203
1232
|
|
|
1204
|
-
**`
|
|
1233
|
+
**`Since`**
|
|
1234
|
+
|
|
1235
|
+
v0.3.5
|
|
1205
1236
|
|
|
1206
1237
|
#### Parameters
|
|
1207
1238
|
|
|
@@ -1219,7 +1250,7 @@ EventEmitter.setMaxListeners
|
|
|
1219
1250
|
|
|
1220
1251
|
#### Defined in
|
|
1221
1252
|
|
|
1222
|
-
node_modules/@types/node/events.d.ts:
|
|
1253
|
+
node_modules/@types/node/ts4.8/events.d.ts:520
|
|
1223
1254
|
|
|
1224
1255
|
___
|
|
1225
1256
|
|
|
@@ -1241,7 +1272,7 @@ Sets the TokenManager to be used for authentication.
|
|
|
1241
1272
|
|
|
1242
1273
|
#### Defined in
|
|
1243
1274
|
|
|
1244
|
-
[src/Application.ts:331](https://github.com/breautek/storm/blob/
|
|
1275
|
+
[src/Application.ts:331](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L331)
|
|
1245
1276
|
|
|
1246
1277
|
___
|
|
1247
1278
|
|
|
@@ -1257,7 +1288,7 @@ true if the Application should bind to an IP address
|
|
|
1257
1288
|
|
|
1258
1289
|
#### Defined in
|
|
1259
1290
|
|
|
1260
|
-
[src/Application.ts:316](https://github.com/breautek/storm/blob/
|
|
1291
|
+
[src/Application.ts:316](https://github.com/breautek/storm/blob/306a47f/src/Application.ts#L316)
|
|
1261
1292
|
|
|
1262
1293
|
___
|
|
1263
1294
|
|
|
@@ -1290,13 +1321,15 @@ const { getEventListeners, EventEmitter } = require('events');
|
|
|
1290
1321
|
}
|
|
1291
1322
|
```
|
|
1292
1323
|
|
|
1293
|
-
**`
|
|
1324
|
+
**`Since`**
|
|
1325
|
+
|
|
1326
|
+
v15.2.0, v14.17.0
|
|
1294
1327
|
|
|
1295
1328
|
#### Parameters
|
|
1296
1329
|
|
|
1297
1330
|
| Name | Type |
|
|
1298
1331
|
| :------ | :------ |
|
|
1299
|
-
| `emitter` | `EventEmitter` \| `
|
|
1332
|
+
| `emitter` | `EventEmitter` \| `_DOMEventTarget` |
|
|
1300
1333
|
| `name` | `string` \| `symbol` |
|
|
1301
1334
|
|
|
1302
1335
|
#### Returns
|
|
@@ -1309,7 +1342,7 @@ EventEmitter.getEventListeners
|
|
|
1309
1342
|
|
|
1310
1343
|
#### Defined in
|
|
1311
1344
|
|
|
1312
|
-
node_modules/@types/node/events.d.ts:
|
|
1345
|
+
node_modules/@types/node/ts4.8/events.d.ts:299
|
|
1313
1346
|
|
|
1314
1347
|
___
|
|
1315
1348
|
|
|
@@ -1328,9 +1361,13 @@ console.log(listenerCount(myEmitter, 'event'));
|
|
|
1328
1361
|
// Prints: 2
|
|
1329
1362
|
```
|
|
1330
1363
|
|
|
1331
|
-
**`
|
|
1364
|
+
**`Since`**
|
|
1332
1365
|
|
|
1333
|
-
|
|
1366
|
+
v0.9.12
|
|
1367
|
+
|
|
1368
|
+
**`Deprecated`**
|
|
1369
|
+
|
|
1370
|
+
Since v3.2.0 - Use `listenerCount` instead.
|
|
1334
1371
|
|
|
1335
1372
|
#### Parameters
|
|
1336
1373
|
|
|
@@ -1349,7 +1386,7 @@ EventEmitter.listenerCount
|
|
|
1349
1386
|
|
|
1350
1387
|
#### Defined in
|
|
1351
1388
|
|
|
1352
|
-
node_modules/@types/node/events.d.ts:
|
|
1389
|
+
node_modules/@types/node/ts4.8/events.d.ts:271
|
|
1353
1390
|
|
|
1354
1391
|
___
|
|
1355
1392
|
|
|
@@ -1411,7 +1448,9 @@ const ac = new AbortController();
|
|
|
1411
1448
|
process.nextTick(() => ac.abort());
|
|
1412
1449
|
```
|
|
1413
1450
|
|
|
1414
|
-
**`
|
|
1451
|
+
**`Since`**
|
|
1452
|
+
|
|
1453
|
+
v13.6.0, v12.16.0
|
|
1415
1454
|
|
|
1416
1455
|
#### Parameters
|
|
1417
1456
|
|
|
@@ -1433,7 +1472,7 @@ EventEmitter.on
|
|
|
1433
1472
|
|
|
1434
1473
|
#### Defined in
|
|
1435
1474
|
|
|
1436
|
-
node_modules/@types/node/events.d.ts:
|
|
1475
|
+
node_modules/@types/node/ts4.8/events.d.ts:254
|
|
1437
1476
|
|
|
1438
1477
|
___
|
|
1439
1478
|
|
|
@@ -1521,13 +1560,15 @@ ac.abort(); // Abort waiting for the event
|
|
|
1521
1560
|
ee.emit('foo'); // Prints: Waiting for the event was canceled!
|
|
1522
1561
|
```
|
|
1523
1562
|
|
|
1524
|
-
**`
|
|
1563
|
+
**`Since`**
|
|
1564
|
+
|
|
1565
|
+
v11.13.0, v10.16.0
|
|
1525
1566
|
|
|
1526
1567
|
#### Parameters
|
|
1527
1568
|
|
|
1528
1569
|
| Name | Type |
|
|
1529
1570
|
| :------ | :------ |
|
|
1530
|
-
| `emitter` | `
|
|
1571
|
+
| `emitter` | `_NodeEventTarget` |
|
|
1531
1572
|
| `eventName` | `string` \| `symbol` |
|
|
1532
1573
|
| `options?` | `StaticEventEmitterOptions` |
|
|
1533
1574
|
|
|
@@ -1541,7 +1582,7 @@ EventEmitter.once
|
|
|
1541
1582
|
|
|
1542
1583
|
#### Defined in
|
|
1543
1584
|
|
|
1544
|
-
node_modules/@types/node/events.d.ts:
|
|
1585
|
+
node_modules/@types/node/ts4.8/events.d.ts:194
|
|
1545
1586
|
|
|
1546
1587
|
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
|
|
1547
1588
|
|
|
@@ -1549,7 +1590,7 @@ node_modules/@types/node/events.d.ts:157
|
|
|
1549
1590
|
|
|
1550
1591
|
| Name | Type |
|
|
1551
1592
|
| :------ | :------ |
|
|
1552
|
-
| `emitter` | `
|
|
1593
|
+
| `emitter` | `_DOMEventTarget` |
|
|
1553
1594
|
| `eventName` | `string` |
|
|
1554
1595
|
| `options?` | `StaticEventEmitterOptions` |
|
|
1555
1596
|
|
|
@@ -1563,4 +1604,45 @@ EventEmitter.once
|
|
|
1563
1604
|
|
|
1564
1605
|
#### Defined in
|
|
1565
1606
|
|
|
1566
|
-
node_modules/@types/node/events.d.ts:
|
|
1607
|
+
node_modules/@types/node/ts4.8/events.d.ts:195
|
|
1608
|
+
|
|
1609
|
+
___
|
|
1610
|
+
|
|
1611
|
+
### setMaxListeners
|
|
1612
|
+
|
|
1613
|
+
▸ `Static` **setMaxListeners**(`n?`, ...`eventTargets`): `void`
|
|
1614
|
+
|
|
1615
|
+
```js
|
|
1616
|
+
const {
|
|
1617
|
+
setMaxListeners,
|
|
1618
|
+
EventEmitter
|
|
1619
|
+
} = require('events');
|
|
1620
|
+
|
|
1621
|
+
const target = new EventTarget();
|
|
1622
|
+
const emitter = new EventEmitter();
|
|
1623
|
+
|
|
1624
|
+
setMaxListeners(5, target, emitter);
|
|
1625
|
+
```
|
|
1626
|
+
|
|
1627
|
+
**`Since`**
|
|
1628
|
+
|
|
1629
|
+
v15.4.0
|
|
1630
|
+
|
|
1631
|
+
#### Parameters
|
|
1632
|
+
|
|
1633
|
+
| Name | Type | Description |
|
|
1634
|
+
| :------ | :------ | :------ |
|
|
1635
|
+
| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. |
|
|
1636
|
+
| `...eventTargets` | (`EventEmitter` \| `_DOMEventTarget`)[] | - |
|
|
1637
|
+
|
|
1638
|
+
#### Returns
|
|
1639
|
+
|
|
1640
|
+
`void`
|
|
1641
|
+
|
|
1642
|
+
#### Inherited from
|
|
1643
|
+
|
|
1644
|
+
EventEmitter.setMaxListeners
|
|
1645
|
+
|
|
1646
|
+
#### Defined in
|
|
1647
|
+
|
|
1648
|
+
node_modules/@types/node/ts4.8/events.d.ts:317
|