dualsense-ts 2.2.0 → 3.0.0

package/docs/Analog.md

@@ -13,8 +13,6 @@ The joystick is abstracted to a unit circle.
 
   ↳ **`Analog`**
 
-  ↳↳ [`Touch`](../wiki/Touch)
-
 ## Table of contents
 
 ### Constructors
@@ -50,7 +48,6 @@ The joystick is abstracted to a unit circle.
 - [degrees](../wiki/Analog#degrees)
 - [direction](../wiki/Analog#direction)
 - [directionDegrees](../wiki/Analog#directiondegrees)
-- [force](../wiki/Analog#force)
 - [magnitude](../wiki/Analog#magnitude)
 - [radians](../wiki/Analog#radians)
 - [vector](../wiki/Analog#vector)
@@ -108,7 +105,7 @@ The joystick is abstracted to a unit circle.
 
 #### Defined in
 
-[src/elements/analog.ts:40](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L40)
+[src/elements/analog.ts:28](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L28)
 
 ## Properties
 
@@ -137,7 +134,7 @@ The joystick is abstracted to a unit circle.
 
 #### 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)
 
 ___
 
@@ -151,7 +148,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 +162,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)
 
 ___
 
@@ -179,7 +176,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)
 
 ___
 
@@ -193,7 +190,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)
 
 ___
 
@@ -201,11 +198,9 @@ ___
 
 • `Readonly` **button**: [`Momentary`](../wiki/Momentary)
 
-Button triggered by pressing the stick.
-
 #### Defined in
 
-[src/elements/analog.ts:38](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L38)
+[src/elements/analog.ts:26](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L26)
 
 ___
 
@@ -219,7 +214,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)
 
 ___
 
@@ -233,7 +228,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)
 
 ___
 
@@ -247,7 +242,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)
 
 ___
 
@@ -261,7 +256,7 @@ ___
 
 #### Defined in
 
-[src/elements/analog.ts:25](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L25)
+[src/elements/analog.ts:22](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L22)
 
 ___
 
@@ -275,7 +270,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)
 
 ___
 
@@ -283,11 +278,9 @@ ___
 
 • `Readonly` **x**: [`Axis`](../wiki/Axis)
 
-The left/right position of the input.
-
 #### Defined in
 
-[src/elements/analog.ts:30](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L30)
+[src/elements/analog.ts:24](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L24)
 
 ___
 
@@ -295,11 +288,9 @@ ___
 
 • `Readonly` **y**: [`Axis`](../wiki/Axis)
 
-The up/down position of the input.
-
 #### Defined in
 
-[src/elements/analog.ts:34](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L34)
+[src/elements/analog.ts:25](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L25)
 
 ___
 
@@ -313,7 +304,7 @@ ___
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:291
+node_modules/@types/node/events.d.ts:301
 
 ___
 
@@ -329,7 +320,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
 
 ___
 
@@ -343,7 +334,7 @@ ___
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:297
+node_modules/@types/node/events.d.ts:307
 
 ___
 
@@ -365,7 +356,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
 
@@ -383,7 +374,7 @@ Input.\_\_@toStringTag@66
 
 #### 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)
 
 ___
 
@@ -391,8 +382,6 @@ ___
 
 • `get` **active**(): `boolean`
 
-Returns true if the stick is away from the idle position, or the button is pressed.
-
 #### Returns
 
 `boolean`
@@ -403,7 +392,7 @@ Input.active
 
 #### Defined in
 
-[src/elements/analog.ts:56](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L56)
+[src/elements/analog.ts:43](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L43)
 
 ___
 
@@ -411,15 +400,13 @@ ___
 
 • `get` **angle**(): `number`
 
-Alias for `.direction`
-
 #### Returns
 
 `number`
 
 #### Defined in
 
-[src/elements/analog.ts:100](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L100)
+[src/elements/analog.ts:68](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L68)
 
 ___
 
@@ -427,15 +414,13 @@ ___
 
 • `get` **angleDegrees**(): `number`
 
-Alias for `.directionDegrees`.
-
 #### Returns
 
 `number`
 
 #### Defined in
 
-[src/elements/analog.ts:121](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L121)
+[src/elements/analog.ts:83](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L83)
 
 ___
 
@@ -443,15 +428,13 @@ ___
 
 • `get` **degrees**(): `number`
 
-Alias for `.directionDegrees`.
-
 #### Returns
 
 `number`
 
 #### Defined in
 
-[src/elements/analog.ts:114](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L114)
+[src/elements/analog.ts:78](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L78)
 
 ___
 
@@ -459,15 +442,13 @@ ___
 
 • `get` **direction**(): `number`
 
-Returns the stick's angle in radians.
-
 #### Returns
 
 `number`
 
 #### Defined in
 
-[src/elements/analog.ts:86](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L86)
+[src/elements/analog.ts:58](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L58)
 
 ___
 
@@ -475,31 +456,13 @@ ___
 
 • `get` **directionDegrees**(): `number`
 
-Alias for `.direction` converted to degrees.
-
-#### Returns
-
-`number`
-
-#### Defined in
-
-[src/elements/analog.ts:107](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L107)
-
-___
-
-### force
-
-• `get` **force**(): `number`
-
-Returns an force from the stick's position.
-
 #### Returns
 
 `number`
 
 #### Defined in
 
-[src/elements/analog.ts:70](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L70)
+[src/elements/analog.ts:73](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L73)
 
 ___
 
@@ -507,15 +470,13 @@ ___
 
 • `get` **magnitude**(): `number`
 
-Returns a magnitude from the stick's position.
-
 #### Returns
 
 `number`
 
 #### Defined in
 
-[src/elements/analog.ts:79](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L79)
+[src/elements/analog.ts:53](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L53)
 
 ___
 
@@ -523,15 +484,13 @@ ___
 
 • `get` **radians**(): `number`
 
-Alias for `.direction`
-
 #### Returns
 
 `number`
 
 #### Defined in
 
-[src/elements/analog.ts:93](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L93)
+[src/elements/analog.ts:63](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L63)
 
 ___
 
@@ -539,8 +498,6 @@ ___
 
 • `get` **vector**(): `Object`
 
-Returns a direction and magnitude representing the stick's position.
-
 #### Returns
 
 `Object`
@@ -552,7 +509,7 @@ Returns a direction and magnitude representing the stick's position.
 
 #### Defined in
 
-[src/elements/analog.ts:63](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L63)
+[src/elements/analog.ts:48](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L48)
 
 ## Methods
 
@@ -573,7 +530,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)
 
 ___
 
@@ -598,7 +555,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)
 
 ___
 
@@ -623,7 +580,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)
 
 ___
 
@@ -641,7 +598,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)
 
 ___
 
@@ -672,7 +629,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)
 
 ___
 
@@ -698,7 +655,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)
 
 ___
 
@@ -716,7 +673,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)
 
 ___
 
@@ -734,7 +691,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)
 
 ___
 
@@ -758,7 +715,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)
 
 ___
 
@@ -787,7 +744,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
 
 ___
 
@@ -812,7 +769,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)
 
 ___
 
@@ -848,7 +805,7 @@ console.log(myEE.eventNames());
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:632
+node_modules/@types/node/events.d.ts:642
 
 ___
 
@@ -871,7 +828,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
 
 ___
 
@@ -899,7 +856,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
 
 ___
 
@@ -935,22 +892,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`<[`Analog`](../wiki/Analog), `any`\>\>
+▸ **next**(): `Promise`<`IteratorResult`<[`Analog`](../wiki/Analog), `any`\>\>
 
 Resolves on the next change to this input's state.
 
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `type` | ``"change"`` \| ``"press"`` \| ``"release"`` | `"change"` |
-
 #### Returns
 
 `Promise`<`IteratorResult`<[`Analog`](../wiki/Analog), `any`\>\>
@@ -961,7 +912,7 @@ Resolves on the next change to this input's state.
 
 #### 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)
 
 ___
 
@@ -990,7 +941,7 @@ Alias for `emitter.removeListener()`.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:462
+node_modules/@types/node/events.d.ts:472
 
 ___
 
@@ -1015,7 +966,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)
 
 ___
 
@@ -1066,7 +1017,7 @@ myEE.emit('foo');
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:377
+node_modules/@types/node/events.d.ts:387
 
 ___
 
@@ -1106,7 +1057,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
 
 ___
 
@@ -1144,22 +1095,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`<[`Analog`](../wiki/Analog)\>
+▸ **promise**(): `Promise`<[`Analog`](../wiki/Analog)\>
 
 Resolves on the next change to this input's state.
 
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `type` | ``"change"`` \| ``"press"`` \| ``"release"`` | `"change"` |
-
 #### Returns
 
 `Promise`<[`Analog`](../wiki/Analog)\>
@@ -1170,7 +1115,7 @@ Resolves on the next change to this input's state.
 
 #### 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)
 
 ___
 
@@ -1223,7 +1168,7 @@ emitter.emit('log');
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:532
+node_modules/@types/node/events.d.ts:542
 
 ___
 
@@ -1257,7 +1202,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
 
 ___
 
@@ -1361,7 +1306,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
 
 ___
 
@@ -1394,7 +1339,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
 
 ___
 
@@ -1414,7 +1359,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)
 
 ___
 
@@ -1466,7 +1411,7 @@ const { getEventListeners, EventEmitter } = require('events');
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:262
+node_modules/@types/node/events.d.ts:270
 
 ___
 
@@ -1506,7 +1451,7 @@ console.log(listenerCount(myEmitter, 'event'));
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:234
+node_modules/@types/node/events.d.ts:242
 
 ___
 
@@ -1590,7 +1535,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
 
 ___
 
@@ -1720,7 +1665,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
 
 ___
 
@@ -1728,26 +1673,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
 
@@ -1759,4 +1709,4 @@ setMaxListeners(5, target, emitter);
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:280
+node_modules/@types/node/events.d.ts:290