dualsense-ts 2.0.13 → 2.1.30

package/docs/Touchpad.md

@@ -20,16 +20,13 @@
 - [[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)
@@ -93,7 +90,7 @@
 
 #### Defined in
 
-[src/elements/touchpad.ts:24](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/elements/touchpad.ts#L24)
+[src/elements/touchpad.ts:18](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/elements/touchpad.ts#L18)
 
 ## Properties
 
@@ -122,7 +119,7 @@
 
 #### Defined in
 
-[src/input.ts:124](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L124)
+[src/input.ts:128](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L128)
 
 ___
 
@@ -136,7 +133,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:158](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L158)
+[src/input.ts:162](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L162)
 
 ___
 
@@ -150,7 +147,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:153](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L153)
+[src/input.ts:157](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L157)
 
 ___
 
@@ -164,7 +161,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:150](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L150)
+[src/input.ts:154](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L154)
 
 ___
 
@@ -178,7 +175,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:156](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L156)
+[src/input.ts:160](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L160)
 
 ___
 
@@ -188,17 +185,7 @@ ___
 
 #### Defined in
 
-[src/elements/touchpad.ts:22](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/elements/touchpad.ts#L22)
-
-___
-
-### direction
-
-• `Readonly` **direction**: `number` = `0`
-
-#### Defined in
-
-[src/elements/touchpad.ts:38](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/elements/touchpad.ts#L38)
+[src/elements/touchpad.ts:12](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/elements/touchpad.ts#L12)
 
 ___
 
@@ -212,7 +199,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:58](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L58)
+[src/input.ts:58](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L58)
 
 ___
 
@@ -226,7 +213,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:61](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L61)
+[src/input.ts:61](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L61)
 
 ___
 
@@ -240,75 +227,55 @@ ___
 
 #### Defined in
 
-[src/input.ts:64](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L64)
+[src/input.ts:64](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L64)
 
 ___
 
-### state
+### left
 
-• `Readonly` **state**: [`Touchpad`](../wiki/Touchpad)
-
-#### Overrides
-
-[Input](../wiki/Input).[state](../wiki/Input#state)
+• `Readonly` **left**: [`Touch`](../wiki/Touch)
 
 #### Defined in
 
-[src/elements/touchpad.ts:6](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/elements/touchpad.ts#L6)
+[src/elements/touchpad.ts:15](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/elements/touchpad.ts#L15)
 
 ___
 
-### threshold
-
-• **threshold**: `number` = `0`
-
-#### Inherited from
+### right
 
-[Input](../wiki/Input).[threshold](../wiki/Input#threshold)
+• `Readonly` **right**: [`Touch`](../wiki/Touch)
 
 #### Defined in
 
-[src/input.ts:67](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L67)
+[src/elements/touchpad.ts:16](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/elements/touchpad.ts#L16)
 
 ___
 
-### x1
-
-• `Readonly` **x1**: [`Axis`](../wiki/Axis)
-
-#### Defined in
-
-[src/elements/touchpad.ts:18](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/elements/touchpad.ts#L18)
+### state
 
-___
+• `Readonly` **state**: [`Touchpad`](../wiki/Touchpad)
 
-### x2
+#### Overrides
 
-• `Readonly` **x2**: [`Axis`](../wiki/Axis)
+[Input](../wiki/Input).[state](../wiki/Input#state)
 
 #### Defined in
 
-[src/elements/touchpad.ts:20](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/elements/touchpad.ts#L20)
+[src/elements/touchpad.ts:6](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/elements/touchpad.ts#L6)
 
 ___
 
-### y1
-
-• `Readonly` **y1**: [`Axis`](../wiki/Axis)
-
-#### Defined in
-
-[src/elements/touchpad.ts:19](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/elements/touchpad.ts#L19)
+### threshold
 
-___
+• **threshold**: `number` = `0`
 
-### y2
+#### Inherited from
 
-• `Readonly` **y2**: [`Axis`](../wiki/Axis)
+[Input](../wiki/Input).[threshold](../wiki/Input#threshold)
 
 #### Defined in
 
-[src/elements/touchpad.ts:21](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/elements/touchpad.ts#L21)
+[src/input.ts:67](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L67)
 
 ___
 
@@ -322,7 +289,7 @@ ___
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:301
+node_modules/@types/node/events.d.ts:291
 
 ___
 
@@ -338,7 +305,7 @@ Sets or gets the default captureRejection value for all emitters.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:306
+node_modules/@types/node/events.d.ts:296
 
 ___
 
@@ -352,7 +319,7 @@ ___
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:307
+node_modules/@types/node/events.d.ts:297
 
 ___
 
@@ -374,7 +341,7 @@ regular `'error'` listener is installed.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:300
+node_modules/@types/node/events.d.ts:290
 
 ## Accessors
 
@@ -392,7 +359,7 @@ Input.\_\_@toStringTag@66
 
 #### Defined in
 
-[src/input.ts:145](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L145)
+[src/input.ts:149](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L149)
 
 ___
 
@@ -410,7 +377,7 @@ Input.active
 
 #### Defined in
 
-[src/elements/touchpad.ts:8](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/elements/touchpad.ts#L8)
+[src/elements/touchpad.ts:8](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/elements/touchpad.ts#L8)
 
 ## Methods
 
@@ -431,7 +398,7 @@ And decide if this is the root Input.
 
 #### Defined in
 
-[src/input.ts:164](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L164)
+[src/input.ts:168](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L168)
 
 ___
 
@@ -456,7 +423,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:186](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L186)
+[src/input.ts:190](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L190)
 
 ___
 
@@ -481,7 +448,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:190](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L190)
+[src/input.ts:194](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L194)
 
 ___
 
@@ -499,7 +466,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:182](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L182)
+[src/input.ts:186](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L186)
 
 ___
 
@@ -530,7 +497,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:195](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L195)
+[src/input.ts:199](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L199)
 
 ___
 
@@ -556,7 +523,7 @@ Update the input's state and trigger all necessary callbacks.
 
 #### Defined in
 
-[src/input.ts:211](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L211)
+[src/input.ts:215](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L215)
 
 ___
 
@@ -574,7 +541,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:135](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L135)
+[src/input.ts:139](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L139)
 
 ___
 
@@ -592,7 +559,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:127](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L127)
+[src/input.ts:131](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L131)
 
 ___
 
@@ -616,7 +583,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:139](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L139)
+[src/input.ts:143](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L143)
 
 ___
 
@@ -645,7 +612,7 @@ Alias for `emitter.on(eventName, listener)`.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:327
+node_modules/@types/node/events.d.ts:317
 
 ___
 
@@ -670,7 +637,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:44](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L44)
+[src/input.ts:44](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L44)
 
 ___
 
@@ -706,7 +673,7 @@ console.log(myEE.eventNames());
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:642
+node_modules/@types/node/events.d.ts:632
 
 ___
 
@@ -729,7 +696,7 @@ set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](../wiki
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:499
+node_modules/@types/node/events.d.ts:489
 
 ___
 
@@ -757,7 +724,7 @@ Returns the number of listeners listening to the event named `eventName`.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:589
+node_modules/@types/node/events.d.ts:579
 
 ___
 
@@ -793,16 +760,22 @@ console.log(util.inspect(server.listeners('connection')));
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:512
+node_modules/@types/node/events.d.ts:502
 
 ___
 
 ### next
 
-▸ **next**(): `Promise`<`IteratorResult`<[`Touchpad`](../wiki/Touchpad), `any`\>\>
+▸ **next**(`type?`): `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`\>\>
@@ -813,7 +786,7 @@ Resolves on the next change to this input's state.
 
 #### Defined in
 
-[src/input.ts:78](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L78)
+[src/input.ts:78](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L78)
 
 ___
 
@@ -842,7 +815,7 @@ Alias for `emitter.removeListener()`.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:472
+node_modules/@types/node/events.d.ts:462
 
 ___
 
@@ -867,7 +840,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:37](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L37)
+[src/input.ts:37](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L37)
 
 ___
 
@@ -918,7 +891,7 @@ myEE.emit('foo');
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:387
+node_modules/@types/node/events.d.ts:377
 
 ___
 
@@ -958,7 +931,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:607
+node_modules/@types/node/events.d.ts:597
 
 ___
 
@@ -996,16 +969,22 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:623
+node_modules/@types/node/events.d.ts:613
 
 ___
 
 ### promise
 
-▸ **promise**(): `Promise`<[`Touchpad`](../wiki/Touchpad)\>
+▸ **promise**(`type?`): `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)\>
@@ -1016,7 +995,7 @@ Resolves on the next change to this input's state.
 
 #### Defined in
 
-[src/input.ts:89](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L89)
+[src/input.ts:91](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L91)
 
 ___
 
@@ -1069,7 +1048,7 @@ emitter.emit('log');
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:542
+node_modules/@types/node/events.d.ts:532
 
 ___
 
@@ -1103,7 +1082,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:473
 
 ___
 
@@ -1207,7 +1186,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:467
+node_modules/@types/node/events.d.ts:457
 
 ___
 
@@ -1240,7 +1219,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:493
+node_modules/@types/node/events.d.ts:483
 
 ___
 
@@ -1260,7 +1239,7 @@ Render a convenient debugging string.
 
 #### Defined in
 
-[src/input.ts:98](https://github.com/nsfm/dualsense-ts/blob/29d69a7/src/input.ts#L98)
+[src/input.ts:102](https://github.com/nsfm/dualsense-ts/blob/04aff39/src/input.ts#L102)
 
 ___
 
@@ -1312,7 +1291,7 @@ const { getEventListeners, EventEmitter } = require('events');
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:270
+node_modules/@types/node/events.d.ts:262
 
 ___
 
@@ -1352,7 +1331,7 @@ console.log(listenerCount(myEmitter, 'event'));
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:242
+node_modules/@types/node/events.d.ts:234
 
 ___
 
@@ -1436,7 +1415,7 @@ that iterates `eventName` events emitted by the `emitter`
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:221
+node_modules/@types/node/events.d.ts:217
 
 ___
 
@@ -1566,7 +1545,7 @@ node_modules/@types/node/events.d.ts:157
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:162
+node_modules/@types/node/events.d.ts:158
 
 ___
 
@@ -1574,31 +1553,26 @@ ___
 
 ▸ `Static` **setMaxListeners**(`n?`, ...`eventTargets`): `void`
 
-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.
-
 ```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);
+const {
+  setMaxListeners,
+  EventEmitter
+} = require('events');
+
+const target = new EventTarget();
+const emitter = new EventEmitter();
+
+setMaxListeners(5, target, emitter);
 ```
 
-**`since`** v15.3.0, v14.17.0
+**`since`** v15.4.0
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `n?` | `number` |
-| `...eventTargets` | (`EventEmitter` \| `DOMEventTarget`)[] |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. |
+| `...eventTargets` | (`EventEmitter` \| `DOMEventTarget`)[] | - |
 
 #### Returns
 
@@ -1610,4 +1584,4 @@ EventEmitter.setMaxListeners(20, eventTarget);
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:290
+node_modules/@types/node/events.d.ts:280