dualsense-ts 2.2.0 → 3.0.0

package/docs/Input.md

@@ -23,8 +23,6 @@ a virtual input, or a group of Input children.
 
   ↳↳ [`Dpad`](../wiki/Dpad)
 
-  ↳↳ [`Increment`](../wiki/Increment)
-
   ↳↳ [`Momentary`](../wiki/Momentary)
 
   ↳↳ [`Touchpad`](../wiki/Touchpad)
@@ -120,7 +118,7 @@ a virtual input, or a group of Input children.
 
 #### Defined in
 
-[src/input.ts:106](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L106)
+[src/input.ts:102](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L102)
 
 ## Properties
 
@@ -145,7 +143,7 @@ a virtual input, or a group of Input children.
 
 #### Defined in
 
-[src/input.ts:128](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L128)
+[src/input.ts:124](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L124)
 
 ___
 
@@ -155,7 +153,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:162](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L162)
+[src/input.ts:158](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L158)
 
 ___
 
@@ -165,7 +163,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:157](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L157)
+[src/input.ts:153](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L153)
 
 ___
 
@@ -175,7 +173,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:154](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L154)
+[src/input.ts:150](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L150)
 
 ___
 
@@ -185,7 +183,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:160](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L160)
+[src/input.ts:156](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L156)
 
 ___
 
@@ -195,7 +193,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:58](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L58)
+[src/input.ts:58](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L58)
 
 ___
 
@@ -205,7 +203,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:61](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L61)
+[src/input.ts:61](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L61)
 
 ___
 
@@ -215,7 +213,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:64](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L64)
+[src/input.ts:64](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L64)
 
 ___
 
@@ -225,7 +223,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:70](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L70)
+[src/input.ts:70](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L70)
 
 ___
 
@@ -235,7 +233,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:67](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L67)
+[src/input.ts:67](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L67)
 
 ___
 
@@ -245,7 +243,7 @@ ___
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:291
+node_modules/@types/node/events.d.ts:301
 
 ___
 
@@ -257,7 +255,7 @@ Sets or gets the default captureRejection value for all emitters.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:296
+node_modules/@types/node/events.d.ts:306
 
 ___
 
@@ -267,7 +265,7 @@ ___
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:297
+node_modules/@types/node/events.d.ts:307
 
 ___
 
@@ -285,7 +283,7 @@ regular `'error'` listener is installed.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:290
+node_modules/@types/node/events.d.ts:300
 
 ## Accessors
 
@@ -299,7 +297,7 @@ node_modules/@types/node/events.d.ts:290
 
 #### Defined in
 
-[src/input.ts:149](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L149)
+[src/input.ts:145](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L145)
 
 ___
 
@@ -313,7 +311,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:73](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L73)
+[src/input.ts:73](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L73)
 
 ## Methods
 
@@ -330,7 +328,7 @@ And decide if this is the root Input.
 
 #### Defined in
 
-[src/input.ts:168](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L168)
+[src/input.ts:164](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L164)
 
 ___
 
@@ -351,7 +349,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:190](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L190)
+[src/input.ts:186](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L186)
 
 ___
 
@@ -372,7 +370,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:194](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L194)
+[src/input.ts:190](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L190)
 
 ___
 
@@ -386,7 +384,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:186](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L186)
+[src/input.ts:182](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L182)
 
 ___
 
@@ -413,7 +411,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:199](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L199)
+[src/input.ts:195](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L195)
 
 ___
 
@@ -435,7 +433,7 @@ Update the input's state and trigger all necessary callbacks.
 
 #### Defined in
 
-[src/input.ts:215](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L215)
+[src/input.ts:211](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L211)
 
 ___
 
@@ -449,7 +447,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:139](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L139)
+[src/input.ts:135](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L135)
 
 ___
 
@@ -463,7 +461,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:131](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L131)
+[src/input.ts:127](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L127)
 
 ___
 
@@ -483,7 +481,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:143](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L143)
+[src/input.ts:139](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L139)
 
 ___
 
@@ -508,7 +506,7 @@ Alias for `emitter.on(eventName, listener)`.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:317
+node_modules/@types/node/events.d.ts:327
 
 ___
 
@@ -529,7 +527,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:44](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L44)
+[src/input.ts:44](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L44)
 
 ___
 
@@ -561,7 +559,7 @@ console.log(myEE.eventNames());
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:632
+node_modules/@types/node/events.d.ts:642
 
 ___
 
@@ -580,7 +578,7 @@ set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](../wiki
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:489
+node_modules/@types/node/events.d.ts:499
 
 ___
 
@@ -604,7 +602,7 @@ Returns the number of listeners listening to the event named `eventName`.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:579
+node_modules/@types/node/events.d.ts:589
 
 ___
 
@@ -636,29 +634,23 @@ console.log(util.inspect(server.listeners('connection')));
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:502
+node_modules/@types/node/events.d.ts:512
 
 ___
 
 ### next
 
-▸ **next**(`type?`): `Promise`<`IteratorResult`<[`Input`](../wiki/Input)<`Type`\>, `any`\>\>
+▸ **next**(): `Promise`<`IteratorResult`<[`Input`](../wiki/Input)<`Type`\>, `any`\>\>
 
 Resolves on the next change to this input's state.
 
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `type` | ``"change"`` \| ``"press"`` \| ``"release"`` | `"change"` |
-
 #### Returns
 
 `Promise`<`IteratorResult`<[`Input`](../wiki/Input)<`Type`\>, `any`\>\>
 
 #### Defined in
 
-[src/input.ts:78](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L78)
+[src/input.ts:78](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L78)
 
 ___
 
@@ -683,7 +675,7 @@ Alias for `emitter.removeListener()`.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:462
+node_modules/@types/node/events.d.ts:472
 
 ___
 
@@ -704,7 +696,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:37](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L37)
+[src/input.ts:37](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L37)
 
 ___
 
@@ -751,7 +743,7 @@ myEE.emit('foo');
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:377
+node_modules/@types/node/events.d.ts:387
 
 ___
 
@@ -787,7 +779,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:597
+node_modules/@types/node/events.d.ts:607
 
 ___
 
@@ -821,29 +813,23 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:613
+node_modules/@types/node/events.d.ts:623
 
 ___
 
 ### promise
 
-▸ **promise**(`type?`): `Promise`<[`Input`](../wiki/Input)<`Type`\>\>
+▸ **promise**(): `Promise`<[`Input`](../wiki/Input)<`Type`\>\>
 
 Resolves on the next change to this input's state.
 
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `type` | ``"change"`` \| ``"press"`` \| ``"release"`` | `"change"` |
-
 #### Returns
 
 `Promise`<[`Input`](../wiki/Input)<`Type`\>\>
 
 #### Defined in
 
-[src/input.ts:91](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L91)
+[src/input.ts:89](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L89)
 
 ___
 
@@ -892,7 +878,7 @@ emitter.emit('log');
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:532
+node_modules/@types/node/events.d.ts:542
 
 ___
 
@@ -922,7 +908,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:473
+node_modules/@types/node/events.d.ts:483
 
 ___
 
@@ -1022,7 +1008,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:457
+node_modules/@types/node/events.d.ts:467
 
 ___
 
@@ -1051,7 +1037,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:483
+node_modules/@types/node/events.d.ts:493
 
 ___
 
@@ -1067,7 +1053,7 @@ Render a convenient debugging string.
 
 #### Defined in
 
-[src/input.ts:102](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L102)
+[src/input.ts:98](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L98)
 
 ___
 
@@ -1115,7 +1101,7 @@ const { getEventListeners, EventEmitter } = require('events');
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:262
+node_modules/@types/node/events.d.ts:270
 
 ___
 
@@ -1151,7 +1137,7 @@ console.log(listenerCount(myEmitter, 'event'));
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:234
+node_modules/@types/node/events.d.ts:242
 
 ___
 
@@ -1231,7 +1217,7 @@ that iterates `eventName` events emitted by the `emitter`
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:217
+node_modules/@types/node/events.d.ts:221
 
 ___
 
@@ -1353,7 +1339,7 @@ node_modules/@types/node/events.d.ts:157
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:158
+node_modules/@types/node/events.d.ts:162
 
 ___
 
@@ -1361,26 +1347,31 @@ ___
 
 ▸ `Static` **setMaxListeners**(`n?`, ...`eventTargets`): `void`
 
-```js
-const {
-  setMaxListeners,
-  EventEmitter
-} = require('events');
-
-const target = new EventTarget();
-const emitter = new EventEmitter();
+By default `EventEmitter`s will print a warning if more than `10` listeners are
+added for a particular event. This is a useful default that helps finding
+memory leaks. The `EventEmitter.setMaxListeners()` method allows the default limit to be
+modified (if eventTargets is empty) or modify the limit specified in every `EventTarget` | `EventEmitter` passed as arguments.
+The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners.
 
-setMaxListeners(5, target, emitter);
+```js
+EventEmitter.setMaxListeners(20);
+// Equivalent to
+EventEmitter.defaultMaxListeners = 20;
+
+const eventTarget = new EventTarget();
+// Only way to increase limit for `EventTarget` instances
+// as these doesn't expose its own `setMaxListeners` method
+EventEmitter.setMaxListeners(20, eventTarget);
 ```
 
-**`since`** v15.4.0
+**`since`** v15.3.0, v14.17.0
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. |
-| `...eventTargets` | (`EventEmitter` \| `DOMEventTarget`)[] | - |
+| Name | Type |
+| :------ | :------ |
+| `n?` | `number` |
+| `...eventTargets` | (`EventEmitter` \| `DOMEventTarget`)[] |
 
 #### Returns
 
@@ -1388,4 +1379,4 @@ setMaxListeners(5, target, emitter);
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:280
+node_modules/@types/node/events.d.ts:290