dualsense-ts 2.2.0 → 3.0.0

package/docs/AnalogParams.md

@@ -1,7 +1,5 @@
 # Interface: AnalogParams
 
-Configuration for an analog joystick and its basic inputs.
-
 ## Hierarchy
 
 - [`InputParams`](../wiki/InputParams)
@@ -28,7 +26,7 @@ Configuration for an analog joystick and its basic inputs.
 
 #### Defined in
 
-[src/elements/analog.ts:10](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L10)
+[src/elements/analog.ts:7](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L7)
 
 ___
 
@@ -42,7 +40,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:6](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L6)
+[src/input.ts:6](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L6)
 
 ___
 
@@ -56,7 +54,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:5](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L5)
+[src/input.ts:5](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L5)
 
 ___
 
@@ -70,7 +68,7 @@ ___
 
 #### Defined in
 
-[src/input.ts:8](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/input.ts#L8)
+[src/input.ts:8](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/input.ts#L8)
 
 ___
 
@@ -84,7 +82,7 @@ ___
 
 #### Defined in
 
-[src/elements/analog.ts:13](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L13)
+[src/elements/analog.ts:10](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L10)
 
 ___
 
@@ -94,7 +92,7 @@ ___
 
 #### Defined in
 
-[src/elements/analog.ts:11](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L11)
+[src/elements/analog.ts:8](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L8)
 
 ___
 
@@ -104,4 +102,4 @@ ___
 
 #### Defined in
 
-[src/elements/analog.ts:12](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/analog.ts#L12)
+[src/elements/analog.ts:9](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/analog.ts#L9)

package/docs/Axis.md

@@ -89,7 +89,7 @@
 
 #### 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
 
@@ -118,7 +118,7 @@
 
 #### 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)
 
 ___
 
@@ -132,7 +132,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)
 
 ___
 
@@ -146,7 +146,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)
 
 ___
 
@@ -160,7 +160,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)
 
 ___
 
@@ -174,7 +174,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)
 
 ___
 
@@ -188,7 +188,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)
 
 ___
 
@@ -202,7 +202,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)
 
 ___
 
@@ -216,7 +216,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)
 
 ___
 
@@ -230,7 +230,7 @@ ___
 
 #### Defined in
 
-[src/elements/axis.ts:5](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/axis.ts#L5)
+[src/elements/axis.ts:5](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/axis.ts#L5)
 
 ___
 
@@ -244,7 +244,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)
 
 ___
 
@@ -258,7 +258,7 @@ ___
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:291
+node_modules/@types/node/events.d.ts:301
 
 ___
 
@@ -274,7 +274,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
 
 ___
 
@@ -288,7 +288,7 @@ ___
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:297
+node_modules/@types/node/events.d.ts:307
 
 ___
 
@@ -310,7 +310,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
 
@@ -328,7 +328,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)
 
 ___
 
@@ -346,7 +346,7 @@ Input.active
 
 #### Defined in
 
-[src/elements/axis.ts:7](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/axis.ts#L7)
+[src/elements/axis.ts:7](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/axis.ts#L7)
 
 ___
 
@@ -360,7 +360,7 @@ ___
 
 #### Defined in
 
-[src/elements/axis.ts:11](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/axis.ts#L11)
+[src/elements/axis.ts:11](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/axis.ts#L11)
 
 ___
 
@@ -374,7 +374,7 @@ ___
 
 #### Defined in
 
-[src/elements/axis.ts:15](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/elements/axis.ts#L15)
+[src/elements/axis.ts:15](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/elements/axis.ts#L15)
 
 ## Methods
 
@@ -395,7 +395,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)
 
 ___
 
@@ -420,7 +420,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)
 
 ___
 
@@ -445,7 +445,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)
 
 ___
 
@@ -463,7 +463,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)
 
 ___
 
@@ -494,7 +494,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)
 
 ___
 
@@ -520,7 +520,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)
 
 ___
 
@@ -538,7 +538,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)
 
 ___
 
@@ -556,7 +556,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)
 
 ___
 
@@ -580,7 +580,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)
 
 ___
 
@@ -609,7 +609,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
 
 ___
 
@@ -634,7 +634,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)
 
 ___
 
@@ -670,7 +670,7 @@ console.log(myEE.eventNames());
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:632
+node_modules/@types/node/events.d.ts:642
 
 ___
 
@@ -693,7 +693,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
 
 ___
 
@@ -721,7 +721,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
 
 ___
 
@@ -757,22 +757,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`<[`Axis`](../wiki/Axis), `any`\>\>
+▸ **next**(): `Promise`<`IteratorResult`<[`Axis`](../wiki/Axis), `any`\>\>
 
 Resolves on the next change to this input's state.
 
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `type` | ``"change"`` \| ``"press"`` \| ``"release"`` | `"change"` |
-
 #### Returns
 
 `Promise`<`IteratorResult`<[`Axis`](../wiki/Axis), `any`\>\>
@@ -783,7 +777,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)
 
 ___
 
@@ -812,7 +806,7 @@ Alias for `emitter.removeListener()`.
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:462
+node_modules/@types/node/events.d.ts:472
 
 ___
 
@@ -837,7 +831,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)
 
 ___
 
@@ -888,7 +882,7 @@ myEE.emit('foo');
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:377
+node_modules/@types/node/events.d.ts:387
 
 ___
 
@@ -928,7 +922,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
 
 ___
 
@@ -966,22 +960,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`<[`Axis`](../wiki/Axis)\>
+▸ **promise**(): `Promise`<[`Axis`](../wiki/Axis)\>
 
 Resolves on the next change to this input's state.
 
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `type` | ``"change"`` \| ``"press"`` \| ``"release"`` | `"change"` |
-
 #### Returns
 
 `Promise`<[`Axis`](../wiki/Axis)\>
@@ -992,7 +980,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)
 
 ___
 
@@ -1045,7 +1033,7 @@ emitter.emit('log');
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:532
+node_modules/@types/node/events.d.ts:542
 
 ___
 
@@ -1079,7 +1067,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
 
 ___
 
@@ -1183,7 +1171,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
 
 ___
 
@@ -1216,7 +1204,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
 
 ___
 
@@ -1236,7 +1224,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)
 
 ___
 
@@ -1288,7 +1276,7 @@ const { getEventListeners, EventEmitter } = require('events');
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:262
+node_modules/@types/node/events.d.ts:270
 
 ___
 
@@ -1328,7 +1316,7 @@ console.log(listenerCount(myEmitter, 'event'));
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:234
+node_modules/@types/node/events.d.ts:242
 
 ___
 
@@ -1412,7 +1400,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
 
 ___
 
@@ -1542,7 +1530,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
 
 ___
 
@@ -1550,26 +1538,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
 
@@ -1581,4 +1574,4 @@ setMaxListeners(5, target, emitter);
 
 #### Defined in
 
-node_modules/@types/node/events.d.ts:280
+node_modules/@types/node/events.d.ts:290

package/docs/Brightness.md

@@ -2,38 +2,38 @@
 
 ## Table of contents
 
-### Enumeration Members
+### Enumeration members
 
 - [High](../wiki/Brightness#high)
 - [Low](../wiki/Brightness#low)
 - [Medium](../wiki/Brightness#medium)
 
-## Enumeration Members
+## Enumeration members
 
 ### High
 
-• **High**
+• **High** = `0`
 
 #### Defined in
 
-[src/hid/command.ts:15](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/hid/command.ts#L15)
+[src/hid/command.ts:15](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/hid/command.ts#L15)
 
 ___
 
 ### Low
 
-• **Low**
+• **Low** = `2`
 
 #### Defined in
 
-[src/hid/command.ts:17](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/hid/command.ts#L17)
+[src/hid/command.ts:17](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/hid/command.ts#L17)
 
 ___
 
 ### Medium
 
-• **Medium**
+• **Medium** = `1`
 
 #### Defined in
 
-[src/hid/command.ts:16](https://github.com/nsfm/dualsense-ts/blob/8aeab4d/src/hid/command.ts#L16)
+[src/hid/command.ts:16](https://github.com/nsfm/dualsense-ts/blob/ab67fa7/src/hid/command.ts#L16)