dualsense-ts 2.1.39 → 2.2.1

package/docs/Touchpad.md

@@ -20,13 +20,16 @@
 - [[InputName]](../wiki/Touchpad#%5Binputname%5D)
 - [[InputParent]](../wiki/Touchpad#%5Binputparent%5D)
 - [button](../wiki/Touchpad#button)
+- [direction](../wiki/Touchpad#direction)
 - [id](../wiki/Touchpad#id)
 - [lastChange](../wiki/Touchpad#lastchange)
 - [lastInput](../wiki/Touchpad#lastinput)
-- [left](../wiki/Touchpad#left)
-- [right](../wiki/Touchpad#right)
 - [state](../wiki/Touchpad#state)
 - [threshold](../wiki/Touchpad#threshold)
+- [x1](../wiki/Touchpad#x1)
+- [x2](../wiki/Touchpad#x2)
+- [y1](../wiki/Touchpad#y1)
+- [y2](../wiki/Touchpad#y2)
 - [captureRejectionSymbol](../wiki/Touchpad#capturerejectionsymbol)
 - [captureRejections](../wiki/Touchpad#capturerejections)
 - [defaultMaxListeners](../wiki/Touchpad#defaultmaxlisteners)
@@ -90,7 +93,7 @@
 
 #### Defined in
 
-[src/elements/touchpad.ts:18](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/elements/touchpad.ts#L18)
+[src/elements/touchpad.ts:24](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/touchpad.ts#L24)
 
 ## Properties
 
@@ -119,7 +122,7 @@
 
 #### Defined in
 
-[src/input.ts:128](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L128)
+[src/input.ts:124](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L124)
 
 ___
 
@@ -133,7 +136,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:162](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L162)
+[src/input.ts:158](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L158)
 
 ___
 
@@ -147,7 +150,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:157](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L157)
+[src/input.ts:153](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L153)
 
 ___
 
@@ -161,7 +164,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:154](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L154)
+[src/input.ts:150](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L150)
 
 ___
 
@@ -175,7 +178,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:160](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L160)
+[src/input.ts:156](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L156)
 
 ___
 
@@ -185,7 +188,17 @@ ___
 
 #### Defined in
 
-[src/elements/touchpad.ts:12](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/elements/touchpad.ts#L12)
+[src/elements/touchpad.ts:22](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/touchpad.ts#L22)
+
+___
+
+### direction
+
+• `Readonly` **direction**: `number` = `0`
+
+#### Defined in
+
+[src/elements/touchpad.ts:38](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/touchpad.ts#L38)
 
 ___
 
@@ -199,7 +212,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:58](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L58)
+[src/input.ts:58](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L58)
 
 ___
 
@@ -213,7 +226,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:61](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L61)
+[src/input.ts:61](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L61)
 
 ___
 
@@ -227,55 +240,75 @@ ___
 
 #### Defined in
 
-[src/input.ts:64](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L64)
+[src/input.ts:64](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L64)
 
 ___
 
-### left
+### state
 
-• `Readonly` **left**: [`Touch`](../wiki/Touch)
+• `Readonly` **state**: [`Touchpad`](../wiki/Touchpad)
+
+#### Overrides
+
+[Input](../wiki/Input).[state](../wiki/Input#state)
 
 #### Defined in
 
-[src/elements/touchpad.ts:15](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/elements/touchpad.ts#L15)
+[src/elements/touchpad.ts:6](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/touchpad.ts#L6)
 
 ___
 
-### right
+### threshold
+
+• **threshold**: `number` = `0`
+
+#### Inherited from
 
-• `Readonly` **right**: [`Touch`](../wiki/Touch)
+[Input](../wiki/Input).[threshold](../wiki/Input#threshold)
 
 #### Defined in
 
-[src/elements/touchpad.ts:16](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/elements/touchpad.ts#L16)
+[src/input.ts:67](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L67)
 
 ___
 
-### state
+### x1
 
-• `Readonly` **state**: [`Touchpad`](../wiki/Touchpad)
+• `Readonly` **x1**: [`Axis`](../wiki/Axis)
 
-#### Overrides
+#### Defined in
 
-[Input](../wiki/Input).[state](../wiki/Input#state)
+[src/elements/touchpad.ts:18](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/touchpad.ts#L18)
+
+___
+
+### x2
+
+• `Readonly` **x2**: [`Axis`](../wiki/Axis)
 
 #### Defined in
 
-[src/elements/touchpad.ts:6](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/elements/touchpad.ts#L6)
+[src/elements/touchpad.ts:20](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/touchpad.ts#L20)
 
 ___
 
-### threshold
+### y1
 
-• **threshold**: `number` = `0`
+• `Readonly` **y1**: [`Axis`](../wiki/Axis)
 
-#### Inherited from
+#### Defined in
 
-[Input](../wiki/Input).[threshold](../wiki/Input#threshold)
+[src/elements/touchpad.ts:19](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/touchpad.ts#L19)
+
+___
+
+### y2
+
+• `Readonly` **y2**: [`Axis`](../wiki/Axis)
 
 #### Defined in
 
-[src/input.ts:67](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L67)
+[src/elements/touchpad.ts:21](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/touchpad.ts#L21)
 
 ___
 
@@ -289,7 +322,7 @@ ___
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:291
+node_modules/@types/node/events.d.ts:301
 
 ___
 
@@ -305,7 +338,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
 
 ___
 
@@ -319,7 +352,7 @@ ___
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:297
+node_modules/@types/node/events.d.ts:307
 
 ___
 
@@ -341,7 +374,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
 
@@ -359,7 +392,7 @@ Input.\_\_@toStringTag@66
 
 #### Defined in
 
-[src/input.ts:149](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L149)
+[src/input.ts:145](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L145)
 
 ___
 
@@ -377,7 +410,7 @@ Input.active
 
 #### Defined in
 
-[src/elements/touchpad.ts:8](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/elements/touchpad.ts#L8)
+[src/elements/touchpad.ts:8](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/touchpad.ts#L8)
 
 ## Methods
 
@@ -398,7 +431,7 @@ And decide if this is the root Input.
 
 #### Defined in
 
-[src/input.ts:168](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L168)
+[src/input.ts:164](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L164)
 
 ___
 
@@ -423,7 +456,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:190](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L190)
+[src/input.ts:186](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L186)
 
 ___
 
@@ -448,7 +481,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:194](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L194)
+[src/input.ts:190](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L190)
 
 ___
 
@@ -466,7 +499,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:186](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L186)
+[src/input.ts:182](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L182)
 
 ___
 
@@ -497,7 +530,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:199](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L199)
+[src/input.ts:195](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L195)
 
 ___
 
@@ -523,7 +556,7 @@ Update the input's state and trigger all necessary callbacks.
 
 #### Defined in
 
-[src/input.ts:215](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L215)
+[src/input.ts:211](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L211)
 
 ___
 
@@ -541,7 +574,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:139](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L139)
+[src/input.ts:135](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L135)
 
 ___
 
@@ -559,7 +592,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:131](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L131)
+[src/input.ts:127](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L127)
 
 ___
 
@@ -583,7 +616,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:143](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L143)
+[src/input.ts:139](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L139)
 
 ___
 
@@ -612,7 +645,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
 
 ___
 
@@ -637,7 +670,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:44](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L44)
+[src/input.ts:44](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L44)
 
 ___
 
@@ -673,7 +706,7 @@ console.log(myEE.eventNames());
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:632
+node_modules/@types/node/events.d.ts:642
 
 ___
 
@@ -696,7 +729,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
 
 ___
 
@@ -724,7 +757,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
 
 ___
 
@@ -760,22 +793,16 @@ 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`<[`Touchpad`](../wiki/Touchpad), `any`\>\>
+▸ **next**(): `Promise`<`IteratorResult`<[`Touchpad`](../wiki/Touchpad), `any`\>\>
 
 Resolves on the next change to this input's state.
 
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `type` | ``"change"`` \| ``"press"`` \| ``"release"`` | `"change"` |
-
 #### Returns
 
 `Promise`<`IteratorResult`<[`Touchpad`](../wiki/Touchpad), `any`\>\>
@@ -786,7 +813,7 @@ Resolves on the next change to this input's state.
 
 #### Defined in
 
-[src/input.ts:78](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L78)
+[src/input.ts:78](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L78)
 
 ___
 
@@ -815,7 +842,7 @@ Alias for `emitter.removeListener()`.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:462
+node_modules/@types/node/events.d.ts:472
 
 ___
 
@@ -840,7 +867,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:37](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L37)
+[src/input.ts:37](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L37)
 
 ___
 
@@ -891,7 +918,7 @@ myEE.emit('foo');
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:377
+node_modules/@types/node/events.d.ts:387
 
 ___
 
@@ -931,7 +958,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
 
 ___
 
@@ -969,22 +996,16 @@ 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`<[`Touchpad`](../wiki/Touchpad)\>
+▸ **promise**(): `Promise`<[`Touchpad`](../wiki/Touchpad)\>
 
 Resolves on the next change to this input's state.
 
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `type` | ``"change"`` \| ``"press"`` \| ``"release"`` | `"change"` |
-
 #### Returns
 
 `Promise`<[`Touchpad`](../wiki/Touchpad)\>
@@ -995,7 +1016,7 @@ Resolves on the next change to this input's state.
 
 #### Defined in
 
-[src/input.ts:91](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L91)
+[src/input.ts:89](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L89)
 
 ___
 
@@ -1048,7 +1069,7 @@ emitter.emit('log');
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:532
+node_modules/@types/node/events.d.ts:542
 
 ___
 
@@ -1082,7 +1103,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
 
 ___
 
@@ -1186,7 +1207,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
 
 ___
 
@@ -1219,7 +1240,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
 
 ___
 
@@ -1239,7 +1260,7 @@ Render a convenient debugging string.
 
 #### Defined in
 
-[src/input.ts:102](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L102)
+[src/input.ts:98](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L98)
 
 ___
 
@@ -1291,7 +1312,7 @@ const { getEventListeners, EventEmitter } = require('events');
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:262
+node_modules/@types/node/events.d.ts:270
 
 ___
 
@@ -1331,7 +1352,7 @@ console.log(listenerCount(myEmitter, 'event'));
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:234
+node_modules/@types/node/events.d.ts:242
 
 ___
 
@@ -1415,7 +1436,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
 
 ___
 
@@ -1545,7 +1566,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
 
 ___
 
@@ -1553,26 +1574,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
 
@@ -1584,4 +1610,4 @@ setMaxListeners(5, target, emitter);
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:280
+node_modules/@types/node/events.d.ts:290