dualsense-ts 2.0.13 → 2.1.30

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 (75) hide show
  1. package/README.md +31 -29
  2. package/dist/dualsense.d.ts.map +1 -1
  3. package/dist/dualsense.js +13 -3
  4. package/dist/dualsense.js.map +1 -1
  5. package/dist/elements/analog.js +2 -2
  6. package/dist/elements/increment.d.ts +6 -0
  7. package/dist/elements/increment.d.ts.map +1 -0
  8. package/dist/elements/increment.js +15 -0
  9. package/dist/elements/increment.js.map +1 -0
  10. package/dist/elements/index.d.ts +2 -0
  11. package/dist/elements/index.d.ts.map +1 -1
  12. package/dist/elements/index.js +2 -0
  13. package/dist/elements/index.js.map +1 -1
  14. package/dist/elements/touch.d.ts +13 -0
  15. package/dist/elements/touch.d.ts.map +1 -0
  16. package/dist/elements/touch.js +22 -0
  17. package/dist/elements/touch.js.map +1 -0
  18. package/dist/elements/touchpad.d.ts +3 -6
  19. package/dist/elements/touchpad.d.ts.map +1 -1
  20. package/dist/elements/touchpad.js +4 -11
  21. package/dist/elements/touchpad.js.map +1 -1
  22. package/dist/elements/unisense.d.ts.map +1 -1
  23. package/dist/elements/unisense.js +2 -2
  24. package/dist/elements/unisense.js.map +1 -1
  25. package/dist/hid/dualsense_hid.d.ts +1 -1
  26. package/dist/hid/dualsense_hid.d.ts.map +1 -1
  27. package/dist/hid/dualsense_hid.js +7 -7
  28. package/dist/hid/dualsense_hid.js.map +1 -1
  29. package/dist/input.d.ts +2 -2
  30. package/dist/input.d.ts.map +1 -1
  31. package/dist/input.js +4 -4
  32. package/dist/input.js.map +1 -1
  33. package/docs/Analog.md +90 -81
  34. package/docs/AnalogParams.md +7 -7
  35. package/docs/Axis.md +79 -72
  36. package/docs/Brightness.md +3 -3
  37. package/docs/CommandScopeA.md +7 -7
  38. package/docs/CommandScopeB.md +6 -6
  39. package/docs/Dpad.md +81 -74
  40. package/docs/DpadParams.md +8 -8
  41. package/docs/DualSenseCommand.md +45 -45
  42. package/docs/Dualsense.md +90 -83
  43. package/docs/DualsenseHID.md +42 -47
  44. package/docs/DualsenseHIDState.md +41 -41
  45. package/docs/DualsenseParams.md +17 -17
  46. package/docs/Exports.md +19 -16
  47. package/docs/Haptic.md +1 -1
  48. package/docs/Home.md +31 -29
  49. package/docs/Increment.md +1554 -0
  50. package/docs/Indicator.md +2 -2
  51. package/docs/Input.md +79 -70
  52. package/docs/InputId.md +41 -41
  53. package/docs/InputParams.md +4 -4
  54. package/docs/LedOptions.md +4 -4
  55. package/docs/Momentary.md +77 -70
  56. package/docs/Motion.md +2 -2
  57. package/docs/Mute.md +79 -72
  58. package/docs/PlayerID.md +5 -5
  59. package/docs/PulseOptions.md +3 -3
  60. package/docs/Touch.md +1781 -0
  61. package/docs/Touchpad.md +94 -120
  62. package/docs/Trigger.md +82 -75
  63. package/docs/TriggerMode.md +10 -10
  64. package/docs/Unisense.md +81 -74
  65. package/docs/UnisenseParams.md +7 -7
  66. package/package.json +2 -2
  67. package/src/dualsense.ts +22 -4
  68. package/src/elements/analog.ts +2 -2
  69. package/src/elements/increment.ts +9 -0
  70. package/src/elements/index.ts +2 -0
  71. package/src/elements/touch.ts +16 -0
  72. package/src/elements/touchpad.ts +9 -23
  73. package/src/elements/unisense.ts +4 -2
  74. package/src/hid/dualsense_hid.ts +13 -7
  75. package/src/input.ts +8 -4
package/docs/Indicator.md CHANGED
@@ -28,7 +28,7 @@
28
28
 
29
29
  #### Defined in
30
30
 
31
- [src/indicators/indicator.ts:6](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/indicators/indicator.ts#L6)
31
+ [src/indicators/indicator.ts:6](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/indicators/indicator.ts#L6)
32
32
 
33
33
  ## Methods
34
34
 
@@ -49,4 +49,4 @@
49
49
 
50
50
  #### Defined in
51
51
 
52
- [src/indicators/indicator.ts:8](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/indicators/indicator.ts#L8)
52
+ [src/indicators/indicator.ts:8](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/indicators/indicator.ts#L8)
package/docs/Input.md CHANGED
@@ -23,6 +23,8 @@ a virtual input, or a group of Input children.
23
23
 
24
24
  ↳↳ [`Dpad`](../wiki/Dpad)
25
25
 
26
+ ↳↳ [`Increment`](../wiki/Increment)
27
+
26
28
  ↳↳ [`Momentary`](../wiki/Momentary)
27
29
 
28
30
  ↳↳ [`Touchpad`](../wiki/Touchpad)
@@ -118,7 +120,7 @@ a virtual input, or a group of Input children.
118
120
 
119
121
  #### Defined in
120
122
 
121
- [src/input.ts:102](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L102)
123
+ [src/input.ts:106](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L106)
122
124
 
123
125
  ## Properties
124
126
 
@@ -143,7 +145,7 @@ a virtual input, or a group of Input children.
143
145
 
144
146
  #### Defined in
145
147
 
146
- [src/input.ts:124](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L124)
148
+ [src/input.ts:128](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L128)
147
149
 
148
150
  ___
149
151
 
@@ -153,7 +155,7 @@ ___
153
155
 
154
156
  #### Defined in
155
157
 
156
- [src/input.ts:158](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L158)
158
+ [src/input.ts:162](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L162)
157
159
 
158
160
  ___
159
161
 
@@ -163,7 +165,7 @@ ___
163
165
 
164
166
  #### Defined in
165
167
 
166
- [src/input.ts:153](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L153)
168
+ [src/input.ts:157](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L157)
167
169
 
168
170
  ___
169
171
 
@@ -173,7 +175,7 @@ ___
173
175
 
174
176
  #### Defined in
175
177
 
176
- [src/input.ts:150](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L150)
178
+ [src/input.ts:154](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L154)
177
179
 
178
180
  ___
179
181
 
@@ -183,7 +185,7 @@ ___
183
185
 
184
186
  #### Defined in
185
187
 
186
- [src/input.ts:156](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L156)
188
+ [src/input.ts:160](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L160)
187
189
 
188
190
  ___
189
191
 
@@ -193,7 +195,7 @@ ___
193
195
 
194
196
  #### Defined in
195
197
 
196
- [src/input.ts:58](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L58)
198
+ [src/input.ts:58](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L58)
197
199
 
198
200
  ___
199
201
 
@@ -203,7 +205,7 @@ ___
203
205
 
204
206
  #### Defined in
205
207
 
206
- [src/input.ts:61](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L61)
208
+ [src/input.ts:61](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L61)
207
209
 
208
210
  ___
209
211
 
@@ -213,7 +215,7 @@ ___
213
215
 
214
216
  #### Defined in
215
217
 
216
- [src/input.ts:64](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L64)
218
+ [src/input.ts:64](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L64)
217
219
 
218
220
  ___
219
221
 
@@ -223,7 +225,7 @@ ___
223
225
 
224
226
  #### Defined in
225
227
 
226
- [src/input.ts:70](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L70)
228
+ [src/input.ts:70](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L70)
227
229
 
228
230
  ___
229
231
 
@@ -233,7 +235,7 @@ ___
233
235
 
234
236
  #### Defined in
235
237
 
236
- [src/input.ts:67](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L67)
238
+ [src/input.ts:67](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L67)
237
239
 
238
240
  ___
239
241
 
@@ -243,7 +245,7 @@ ___
243
245
 
244
246
  #### Defined in
245
247
 
246
- node_modules/@types/node/events.d.ts:301
248
+ node_modules/@types/node/events.d.ts:291
247
249
 
248
250
  ___
249
251
 
@@ -255,7 +257,7 @@ Sets or gets the default captureRejection value for all emitters.
255
257
 
256
258
  #### Defined in
257
259
 
258
- node_modules/@types/node/events.d.ts:306
260
+ node_modules/@types/node/events.d.ts:296
259
261
 
260
262
  ___
261
263
 
@@ -265,7 +267,7 @@ ___
265
267
 
266
268
  #### Defined in
267
269
 
268
- node_modules/@types/node/events.d.ts:307
270
+ node_modules/@types/node/events.d.ts:297
269
271
 
270
272
  ___
271
273
 
@@ -283,7 +285,7 @@ regular `'error'` listener is installed.
283
285
 
284
286
  #### Defined in
285
287
 
286
- node_modules/@types/node/events.d.ts:300
288
+ node_modules/@types/node/events.d.ts:290
287
289
 
288
290
  ## Accessors
289
291
 
@@ -297,7 +299,7 @@ node_modules/@types/node/events.d.ts:300
297
299
 
298
300
  #### Defined in
299
301
 
300
- [src/input.ts:145](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L145)
302
+ [src/input.ts:149](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L149)
301
303
 
302
304
  ___
303
305
 
@@ -311,7 +313,7 @@ ___
311
313
 
312
314
  #### Defined in
313
315
 
314
- [src/input.ts:73](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L73)
316
+ [src/input.ts:73](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L73)
315
317
 
316
318
  ## Methods
317
319
 
@@ -328,7 +330,7 @@ And decide if this is the root Input.
328
330
 
329
331
  #### Defined in
330
332
 
331
- [src/input.ts:164](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L164)
333
+ [src/input.ts:168](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L168)
332
334
 
333
335
  ___
334
336
 
@@ -349,7 +351,7 @@ ___
349
351
 
350
352
  #### Defined in
351
353
 
352
- [src/input.ts:186](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L186)
354
+ [src/input.ts:190](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L190)
353
355
 
354
356
  ___
355
357
 
@@ -370,7 +372,7 @@ ___
370
372
 
371
373
  #### Defined in
372
374
 
373
- [src/input.ts:190](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L190)
375
+ [src/input.ts:194](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L194)
374
376
 
375
377
  ___
376
378
 
@@ -384,7 +386,7 @@ ___
384
386
 
385
387
  #### Defined in
386
388
 
387
- [src/input.ts:182](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L182)
389
+ [src/input.ts:186](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L186)
388
390
 
389
391
  ___
390
392
 
@@ -411,7 +413,7 @@ ___
411
413
 
412
414
  #### Defined in
413
415
 
414
- [src/input.ts:195](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L195)
416
+ [src/input.ts:199](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L199)
415
417
 
416
418
  ___
417
419
 
@@ -433,7 +435,7 @@ Update the input's state and trigger all necessary callbacks.
433
435
 
434
436
  #### Defined in
435
437
 
436
- [src/input.ts:211](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L211)
438
+ [src/input.ts:215](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L215)
437
439
 
438
440
  ___
439
441
 
@@ -447,7 +449,7 @@ ___
447
449
 
448
450
  #### Defined in
449
451
 
450
- [src/input.ts:135](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L135)
452
+ [src/input.ts:139](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L139)
451
453
 
452
454
  ___
453
455
 
@@ -461,7 +463,7 @@ ___
461
463
 
462
464
  #### Defined in
463
465
 
464
- [src/input.ts:127](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L127)
466
+ [src/input.ts:131](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L131)
465
467
 
466
468
  ___
467
469
 
@@ -481,7 +483,7 @@ ___
481
483
 
482
484
  #### Defined in
483
485
 
484
- [src/input.ts:139](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L139)
486
+ [src/input.ts:143](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L143)
485
487
 
486
488
  ___
487
489
 
@@ -506,7 +508,7 @@ Alias for `emitter.on(eventName, listener)`.
506
508
 
507
509
  #### Defined in
508
510
 
509
- node_modules/@types/node/events.d.ts:327
511
+ node_modules/@types/node/events.d.ts:317
510
512
 
511
513
  ___
512
514
 
@@ -527,7 +529,7 @@ ___
527
529
 
528
530
  #### Defined in
529
531
 
530
- [src/input.ts:44](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L44)
532
+ [src/input.ts:44](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L44)
531
533
 
532
534
  ___
533
535
 
@@ -559,7 +561,7 @@ console.log(myEE.eventNames());
559
561
 
560
562
  #### Defined in
561
563
 
562
- node_modules/@types/node/events.d.ts:642
564
+ node_modules/@types/node/events.d.ts:632
563
565
 
564
566
  ___
565
567
 
@@ -578,7 +580,7 @@ set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](../wiki
578
580
 
579
581
  #### Defined in
580
582
 
581
- node_modules/@types/node/events.d.ts:499
583
+ node_modules/@types/node/events.d.ts:489
582
584
 
583
585
  ___
584
586
 
@@ -602,7 +604,7 @@ Returns the number of listeners listening to the event named `eventName`.
602
604
 
603
605
  #### Defined in
604
606
 
605
- node_modules/@types/node/events.d.ts:589
607
+ node_modules/@types/node/events.d.ts:579
606
608
 
607
609
  ___
608
610
 
@@ -634,23 +636,29 @@ console.log(util.inspect(server.listeners('connection')));
634
636
 
635
637
  #### Defined in
636
638
 
637
- node_modules/@types/node/events.d.ts:512
639
+ node_modules/@types/node/events.d.ts:502
638
640
 
639
641
  ___
640
642
 
641
643
  ### next
642
644
 
643
- ▸ **next**(): `Promise`<`IteratorResult`<[`Input`](../wiki/Input)<`Type`\>, `any`\>\>
645
+ ▸ **next**(`type?`): `Promise`<`IteratorResult`<[`Input`](../wiki/Input)<`Type`\>, `any`\>\>
644
646
 
645
647
  Resolves on the next change to this input's state.
646
648
 
649
+ #### Parameters
650
+
651
+ | Name | Type | Default value |
652
+ | :------ | :------ | :------ |
653
+ | `type` | ``"change"`` \| ``"press"`` \| ``"release"`` | `"change"` |
654
+
647
655
  #### Returns
648
656
 
649
657
  `Promise`<`IteratorResult`<[`Input`](../wiki/Input)<`Type`\>, `any`\>\>
650
658
 
651
659
  #### Defined in
652
660
 
653
- [src/input.ts:78](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L78)
661
+ [src/input.ts:78](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L78)
654
662
 
655
663
  ___
656
664
 
@@ -675,7 +683,7 @@ Alias for `emitter.removeListener()`.
675
683
 
676
684
  #### Defined in
677
685
 
678
- node_modules/@types/node/events.d.ts:472
686
+ node_modules/@types/node/events.d.ts:462
679
687
 
680
688
  ___
681
689
 
@@ -696,7 +704,7 @@ ___
696
704
 
697
705
  #### Defined in
698
706
 
699
- [src/input.ts:37](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L37)
707
+ [src/input.ts:37](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L37)
700
708
 
701
709
  ___
702
710
 
@@ -743,7 +751,7 @@ myEE.emit('foo');
743
751
 
744
752
  #### Defined in
745
753
 
746
- node_modules/@types/node/events.d.ts:387
754
+ node_modules/@types/node/events.d.ts:377
747
755
 
748
756
  ___
749
757
 
@@ -779,7 +787,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
779
787
 
780
788
  #### Defined in
781
789
 
782
- node_modules/@types/node/events.d.ts:607
790
+ node_modules/@types/node/events.d.ts:597
783
791
 
784
792
  ___
785
793
 
@@ -813,23 +821,29 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
813
821
 
814
822
  #### Defined in
815
823
 
816
- node_modules/@types/node/events.d.ts:623
824
+ node_modules/@types/node/events.d.ts:613
817
825
 
818
826
  ___
819
827
 
820
828
  ### promise
821
829
 
822
- ▸ **promise**(): `Promise`<[`Input`](../wiki/Input)<`Type`\>\>
830
+ ▸ **promise**(`type?`): `Promise`<[`Input`](../wiki/Input)<`Type`\>\>
823
831
 
824
832
  Resolves on the next change to this input's state.
825
833
 
834
+ #### Parameters
835
+
836
+ | Name | Type | Default value |
837
+ | :------ | :------ | :------ |
838
+ | `type` | ``"change"`` \| ``"press"`` \| ``"release"`` | `"change"` |
839
+
826
840
  #### Returns
827
841
 
828
842
  `Promise`<[`Input`](../wiki/Input)<`Type`\>\>
829
843
 
830
844
  #### Defined in
831
845
 
832
- [src/input.ts:89](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L89)
846
+ [src/input.ts:91](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L91)
833
847
 
834
848
  ___
835
849
 
@@ -878,7 +892,7 @@ emitter.emit('log');
878
892
 
879
893
  #### Defined in
880
894
 
881
- node_modules/@types/node/events.d.ts:542
895
+ node_modules/@types/node/events.d.ts:532
882
896
 
883
897
  ___
884
898
 
@@ -908,7 +922,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
908
922
 
909
923
  #### Defined in
910
924
 
911
- node_modules/@types/node/events.d.ts:483
925
+ node_modules/@types/node/events.d.ts:473
912
926
 
913
927
  ___
914
928
 
@@ -1008,7 +1022,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
1008
1022
 
1009
1023
  #### Defined in
1010
1024
 
1011
- node_modules/@types/node/events.d.ts:467
1025
+ node_modules/@types/node/events.d.ts:457
1012
1026
 
1013
1027
  ___
1014
1028
 
@@ -1037,7 +1051,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
1037
1051
 
1038
1052
  #### Defined in
1039
1053
 
1040
- node_modules/@types/node/events.d.ts:493
1054
+ node_modules/@types/node/events.d.ts:483
1041
1055
 
1042
1056
  ___
1043
1057
 
@@ -1053,7 +1067,7 @@ Render a convenient debugging string.
1053
1067
 
1054
1068
  #### Defined in
1055
1069
 
1056
- [src/input.ts:98](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L98)
1070
+ [src/input.ts:102](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L102)
1057
1071
 
1058
1072
  ___
1059
1073
 
@@ -1101,7 +1115,7 @@ const { getEventListeners, EventEmitter } = require('events');
1101
1115
 
1102
1116
  #### Defined in
1103
1117
 
1104
- node_modules/@types/node/events.d.ts:270
1118
+ node_modules/@types/node/events.d.ts:262
1105
1119
 
1106
1120
  ___
1107
1121
 
@@ -1137,7 +1151,7 @@ console.log(listenerCount(myEmitter, 'event'));
1137
1151
 
1138
1152
  #### Defined in
1139
1153
 
1140
- node_modules/@types/node/events.d.ts:242
1154
+ node_modules/@types/node/events.d.ts:234
1141
1155
 
1142
1156
  ___
1143
1157
 
@@ -1217,7 +1231,7 @@ that iterates `eventName` events emitted by the `emitter`
1217
1231
 
1218
1232
  #### Defined in
1219
1233
 
1220
- node_modules/@types/node/events.d.ts:221
1234
+ node_modules/@types/node/events.d.ts:217
1221
1235
 
1222
1236
  ___
1223
1237
 
@@ -1339,7 +1353,7 @@ node_modules/@types/node/events.d.ts:157
1339
1353
 
1340
1354
  #### Defined in
1341
1355
 
1342
- node_modules/@types/node/events.d.ts:162
1356
+ node_modules/@types/node/events.d.ts:158
1343
1357
 
1344
1358
  ___
1345
1359
 
@@ -1347,31 +1361,26 @@ ___
1347
1361
 
1348
1362
  ▸ `Static` **setMaxListeners**(`n?`, ...`eventTargets`): `void`
1349
1363
 
1350
- By default `EventEmitter`s will print a warning if more than `10` listeners are
1351
- added for a particular event. This is a useful default that helps finding
1352
- memory leaks. The `EventEmitter.setMaxListeners()` method allows the default limit to be
1353
- modified (if eventTargets is empty) or modify the limit specified in every `EventTarget` | `EventEmitter` passed as arguments.
1354
- The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners.
1355
-
1356
1364
  ```js
1357
- EventEmitter.setMaxListeners(20);
1358
- // Equivalent to
1359
- EventEmitter.defaultMaxListeners = 20;
1360
-
1361
- const eventTarget = new EventTarget();
1362
- // Only way to increase limit for `EventTarget` instances
1363
- // as these doesn't expose its own `setMaxListeners` method
1364
- EventEmitter.setMaxListeners(20, eventTarget);
1365
+ const {
1366
+ setMaxListeners,
1367
+ EventEmitter
1368
+ } = require('events');
1369
+
1370
+ const target = new EventTarget();
1371
+ const emitter = new EventEmitter();
1372
+
1373
+ setMaxListeners(5, target, emitter);
1365
1374
  ```
1366
1375
 
1367
- **`since`** v15.3.0, v14.17.0
1376
+ **`since`** v15.4.0
1368
1377
 
1369
1378
  #### Parameters
1370
1379
 
1371
- | Name | Type |
1372
- | :------ | :------ |
1373
- | `n?` | `number` |
1374
- | `...eventTargets` | (`EventEmitter` \| `DOMEventTarget`)[] |
1380
+ | Name | Type | Description |
1381
+ | :------ | :------ | :------ |
1382
+ | `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. |
1383
+ | `...eventTargets` | (`EventEmitter` \| `DOMEventTarget`)[] | - |
1375
1384
 
1376
1385
  #### Returns
1377
1386
 
@@ -1379,4 +1388,4 @@ EventEmitter.setMaxListeners(20, eventTarget);
1379
1388
 
1380
1389
  #### Defined in
1381
1390
 
1382
- node_modules/@types/node/events.d.ts:290
1391
+ node_modules/@types/node/events.d.ts:280