dualsense-ts 2.1.39 → 2.2.1

package/docs/Increment.md

@@ -1,1554 +0,0 @@
-# Class: Increment
-
-## Hierarchy
-
-- [`Input`](../wiki/Input)<`number`\>
-
-  ↳ **`Increment`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](../wiki/Increment#constructor)
-
-### Properties
-
-- [[InputChanged]](../wiki/Increment#%5Binputchanged%5D)
-- [[InputChildless]](../wiki/Increment#%5Binputchildless%5D)
-- [[InputIcon]](../wiki/Increment#%5Binputicon%5D)
-- [[InputName]](../wiki/Increment#%5Binputname%5D)
-- [[InputParent]](../wiki/Increment#%5Binputparent%5D)
-- [id](../wiki/Increment#id)
-- [lastChange](../wiki/Increment#lastchange)
-- [lastInput](../wiki/Increment#lastinput)
-- [state](../wiki/Increment#state)
-- [threshold](../wiki/Increment#threshold)
-- [captureRejectionSymbol](../wiki/Increment#capturerejectionsymbol)
-- [captureRejections](../wiki/Increment#capturerejections)
-- [defaultMaxListeners](../wiki/Increment#defaultmaxlisteners)
-- [errorMonitor](../wiki/Increment#errormonitor)
-
-### Accessors
-
-- [[toStringTag]](../wiki/Increment#%5Btostringtag%5D)
-- [active](../wiki/Increment#active)
-
-### Methods
-
-- [[InputAdopt]](../wiki/Increment#%5Binputadopt%5D)
-- [[InputChangedPrimitive]](../wiki/Increment#%5Binputchangedprimitive%5D)
-- [[InputChangedThreshold]](../wiki/Increment#%5Binputchangedthreshold%5D)
-- [[InputChangedVirtual]](../wiki/Increment#%5Binputchangedvirtual%5D)
-- [[InputSetComparison]](../wiki/Increment#%5Binputsetcomparison%5D)
-- [[InputSet]](../wiki/Increment#%5Binputset%5D)
-- [[asyncIterator]](../wiki/Increment#%5Basynciterator%5D)
-- [[custom]](../wiki/Increment#%5Bcustom%5D)
-- [[toPrimitive]](../wiki/Increment#%5Btoprimitive%5D)
-- [addListener](../wiki/Increment#addlistener)
-- [emit](../wiki/Increment#emit)
-- [eventNames](../wiki/Increment#eventnames)
-- [getMaxListeners](../wiki/Increment#getmaxlisteners)
-- [listenerCount](../wiki/Increment#listenercount)
-- [listeners](../wiki/Increment#listeners)
-- [next](../wiki/Increment#next)
-- [off](../wiki/Increment#off)
-- [on](../wiki/Increment#on)
-- [once](../wiki/Increment#once)
-- [prependListener](../wiki/Increment#prependlistener)
-- [prependOnceListener](../wiki/Increment#prependoncelistener)
-- [promise](../wiki/Increment#promise)
-- [rawListeners](../wiki/Increment#rawlisteners)
-- [removeAllListeners](../wiki/Increment#removealllisteners)
-- [removeListener](../wiki/Increment#removelistener)
-- [setMaxListeners](../wiki/Increment#setmaxlisteners)
-- [toString](../wiki/Increment#tostring)
-- [getEventListeners](../wiki/Increment#geteventlisteners)
-- [listenerCount](../wiki/Increment#listenercount-1)
-- [on](../wiki/Increment#on-1)
-- [once](../wiki/Increment#once-1)
-- [setMaxListeners](../wiki/Increment#setmaxlisteners-1)
-
-## Constructors
-
-### constructor
-
-• **new Increment**(`params?`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `params?` | [`InputParams`](../wiki/InputParams) |
-
-#### Inherited from
-
-[Input](../wiki/Input).[constructor](../wiki/Input#constructor)
-
-#### Defined in
-
-[src/input.ts:106](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L106)
-
-## Properties
-
-### [InputChanged]
-
-• **[InputChanged]**: (`state`: `number`, `newState`: `number`) => `boolean`
-
-#### Type declaration
-
-▸ (`state`, `newState`): `boolean`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `state` | `number` |
-| `newState` | `number` |
-
-##### Returns
-
-`boolean`
-
-#### Inherited from
-
-[Input](../wiki/Input).[[InputChanged]](../wiki/Input#%5Binputchanged%5D)
-
-#### Defined in
-
-[src/input.ts:128](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L128)
-
-___
-
-### [InputChildless]
-
-• **[InputChildless]**: `boolean` = `true`
-
-#### Inherited from
-
-[Input](../wiki/Input).[[InputChildless]](../wiki/Input#%5Binputchildless%5D)
-
-#### Defined in
-
-[src/input.ts:162](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L162)
-
-___
-
-### [InputIcon]
-
-• `Readonly` **[InputIcon]**: `string`
-
-#### Inherited from
-
-[Input](../wiki/Input).[[InputIcon]](../wiki/Input#%5Binputicon%5D)
-
-#### Defined in
-
-[src/input.ts:157](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L157)
-
-___
-
-### [InputName]
-
-• `Readonly` **[InputName]**: `string`
-
-#### Inherited from
-
-[Input](../wiki/Input).[[InputName]](../wiki/Input#%5Binputname%5D)
-
-#### Defined in
-
-[src/input.ts:154](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L154)
-
-___
-
-### [InputParent]
-
-• `Optional` **[InputParent]**: [`Input`](../wiki/Input)<`unknown`\>
-
-#### Inherited from
-
-[Input](../wiki/Input).[[InputParent]](../wiki/Input#%5Binputparent%5D)
-
-#### Defined in
-
-[src/input.ts:160](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L160)
-
-___
-
-### id
-
-• `Readonly` **id**: `symbol`
-
-#### Inherited from
-
-[Input](../wiki/Input).[id](../wiki/Input#id)
-
-#### Defined in
-
-[src/input.ts:58](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L58)
-
-___
-
-### lastChange
-
-• **lastChange**: `number`
-
-#### Inherited from
-
-[Input](../wiki/Input).[lastChange](../wiki/Input#lastchange)
-
-#### Defined in
-
-[src/input.ts:61](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L61)
-
-___
-
-### lastInput
-
-• **lastInput**: `number`
-
-#### Inherited from
-
-[Input](../wiki/Input).[lastInput](../wiki/Input#lastinput)
-
-#### Defined in
-
-[src/input.ts:64](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L64)
-
-___
-
-### state
-
-• **state**: `number` = `0`
-
-#### Overrides
-
-[Input](../wiki/Input).[state](../wiki/Input#state)
-
-#### Defined in
-
-[src/elements/increment.ts:4](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/elements/increment.ts#L4)
-
-___
-
-### threshold
-
-• **threshold**: `number` = `0`
-
-#### Inherited from
-
-[Input](../wiki/Input).[threshold](../wiki/Input#threshold)
-
-#### Defined in
-
-[src/input.ts:67](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L67)
-
-___
-
-### captureRejectionSymbol
-
-▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](../wiki/Dualsense#capturerejectionsymbol)
-
-#### Inherited from
-
-[Input](../wiki/Input).[captureRejectionSymbol](../wiki/Input#capturerejectionsymbol)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:291
-
-___
-
-### captureRejections
-
-▪ `Static` **captureRejections**: `boolean`
-
-Sets or gets the default captureRejection value for all emitters.
-
-#### Inherited from
-
-[Input](../wiki/Input).[captureRejections](../wiki/Input#capturerejections)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:296
-
-___
-
-### defaultMaxListeners
-
-▪ `Static` **defaultMaxListeners**: `number`
-
-#### Inherited from
-
-[Input](../wiki/Input).[defaultMaxListeners](../wiki/Input#defaultmaxlisteners)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:297
-
-___
-
-### errorMonitor
-
-▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](../wiki/Dualsense#errormonitor)
-
-This symbol shall be used to install a listener for only monitoring `'error'`
-events. Listeners installed using this symbol are called before the regular
-`'error'` listeners are called.
-
-Installing a listener using this symbol does not change the behavior once an
-`'error'` event is emitted, therefore the process will still crash if no
-regular `'error'` listener is installed.
-
-#### Inherited from
-
-[Input](../wiki/Input).[errorMonitor](../wiki/Input#errormonitor)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:290
-
-## Accessors
-
-### [toStringTag]
-
-• `get` **[toStringTag]**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-Input.\_\_@toStringTag@66
-
-#### Defined in
-
-[src/input.ts:149](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L149)
-
-___
-
-### active
-
-• `get` **active**(): `boolean`
-
-#### Returns
-
-`boolean`
-
-#### Overrides
-
-Input.active
-
-#### Defined in
-
-[src/elements/increment.ts:6](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/elements/increment.ts#L6)
-
-## Methods
-
-### [InputAdopt]
-
-▸ **[InputAdopt]**(): `void`
-
-Cascade events from nested Inputs.
-And decide if this is the root Input.
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Input](../wiki/Input).[[InputAdopt]](../wiki/Input#%5Binputadopt%5D)
-
-#### Defined in
-
-[src/input.ts:168](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L168)
-
-___
-
-### [InputChangedPrimitive]
-
-▸ **[InputChangedPrimitive]**(`state`, `newState`): `boolean`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `state` | `number` |
-| `newState` | `number` |
-
-#### Returns
-
-`boolean`
-
-#### Inherited from
-
-[Input](../wiki/Input).[[InputChangedPrimitive]](../wiki/Input#%5Binputchangedprimitive%5D)
-
-#### Defined in
-
-[src/input.ts:190](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L190)
-
-___
-
-### [InputChangedThreshold]
-
-▸ **[InputChangedThreshold]**(`state`, `newState`): `boolean`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `state` | `number` |
-| `newState` | `number` |
-
-#### Returns
-
-`boolean`
-
-#### Inherited from
-
-[Input](../wiki/Input).[[InputChangedThreshold]](../wiki/Input#%5Binputchangedthreshold%5D)
-
-#### Defined in
-
-[src/input.ts:194](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L194)
-
-___
-
-### [InputChangedVirtual]
-
-▸ **[InputChangedVirtual]**(): `boolean`
-
-#### Returns
-
-`boolean`
-
-#### Inherited from
-
-[Input](../wiki/Input).[[InputChangedVirtual]](../wiki/Input#%5Binputchangedvirtual%5D)
-
-#### Defined in
-
-[src/input.ts:186](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L186)
-
-___
-
-### [InputSetComparison]
-
-▸ **[InputSetComparison]**(): (`state`: `number`, `newState`: `number`) => `boolean`
-
-#### Returns
-
-`fn`
-
-▸ (`state`, `newState`): `boolean`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `state` | `number` |
-| `newState` | `number` |
-
-##### Returns
-
-`boolean`
-
-#### Inherited from
-
-[Input](../wiki/Input).[[InputSetComparison]](../wiki/Input#%5Binputsetcomparison%5D)
-
-#### Defined in
-
-[src/input.ts:199](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L199)
-
-___
-
-### [InputSet]
-
-▸ **[InputSet]**(`state`): `void`
-
-Update the input's state and trigger all necessary callbacks.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `state` | `number` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Input](../wiki/Input).[[InputSet]](../wiki/Input#%5Binputset%5D)
-
-#### Defined in
-
-[src/input.ts:215](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L215)
-
-___
-
-### [asyncIterator]
-
-▸ **[asyncIterator]**(): `AsyncIterator`<[`Increment`](../wiki/Increment), `any`, `undefined`\>
-
-#### Returns
-
-`AsyncIterator`<[`Increment`](../wiki/Increment), `any`, `undefined`\>
-
-#### Inherited from
-
-[Input](../wiki/Input).[[asyncIterator]](../wiki/Input#%5Basynciterator%5D)
-
-#### Defined in
-
-[src/input.ts:139](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L139)
-
-___
-
-### [custom]
-
-▸ **[custom]**(): `string`
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[Input](../wiki/Input).[[custom]](../wiki/Input#%5Bcustom%5D)
-
-#### Defined in
-
-[src/input.ts:131](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L131)
-
-___
-
-### [toPrimitive]
-
-▸ **[toPrimitive]**(`hint`): `string` \| `number`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `hint` | ``"string"`` \| ``"number"`` \| ``"default"`` |
-
-#### Returns
-
-`string` \| `number`
-
-#### Inherited from
-
-[Input](../wiki/Input).[[toPrimitive]](../wiki/Input#%5Btoprimitive%5D)
-
-#### Defined in
-
-[src/input.ts:143](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L143)
-
-___
-
-### addListener
-
-▸ **addListener**(`eventName`, `listener`): [`Increment`](../wiki/Increment)
-
-Alias for `emitter.on(eventName, listener)`.
-
-**`since`** v0.1.26
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `eventName` | `string` \| `symbol` |
-| `listener` | (...`args`: `any`[]) => `void` |
-
-#### Returns
-
-[`Increment`](../wiki/Increment)
-
-#### Inherited from
-
-[Input](../wiki/Input).[addListener](../wiki/Input#addlistener)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:317
-
-___
-
-### emit
-
-▸ **emit**(`event`, ...`args`): `boolean`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `event` | [`InputEvent`](../wiki/Exports#inputevent) |
-| `...args` | [[`Input`](../wiki/Input)<`number`\>, [`Input`](../wiki/Input)<`unknown`\> \| [`Input`](../wiki/Input)<`number`\>] |
-
-#### Returns
-
-`boolean`
-
-#### Inherited from
-
-[Input](../wiki/Input).[emit](../wiki/Input#emit)
-
-#### Defined in
-
-[src/input.ts:44](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L44)
-
-___
-
-### eventNames
-
-▸ **eventNames**(): (`string` \| `symbol`)[]
-
-Returns an array listing the events for which the emitter has registered
-listeners. The values in the array are strings or `Symbol`s.
-
-```js
-const EventEmitter = require('events');
-const myEE = new EventEmitter();
-myEE.on('foo', () => {});
-myEE.on('bar', () => {});
-
-const sym = Symbol('symbol');
-myEE.on(sym, () => {});
-
-console.log(myEE.eventNames());
-// Prints: [ 'foo', 'bar', Symbol(symbol) ]
-```
-
-**`since`** v6.0.0
-
-#### Returns
-
-(`string` \| `symbol`)[]
-
-#### Inherited from
-
-[Input](../wiki/Input).[eventNames](../wiki/Input#eventnames)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:632
-
-___
-
-### getMaxListeners
-
-▸ **getMaxListeners**(): `number`
-
-Returns the current max listener value for the `EventEmitter` which is either
-set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](../wiki/Increment#defaultmaxlisteners).
-
-**`since`** v1.0.0
-
-#### Returns
-
-`number`
-
-#### Inherited from
-
-[Input](../wiki/Input).[getMaxListeners](../wiki/Input#getmaxlisteners)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:489
-
-___
-
-### listenerCount
-
-▸ **listenerCount**(`eventName`): `number`
-
-Returns the number of listeners listening to the event named `eventName`.
-
-**`since`** v3.2.0
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` \| `symbol` | The name of the event being listened for |
-
-#### Returns
-
-`number`
-
-#### Inherited from
-
-[Input](../wiki/Input).[listenerCount](../wiki/Input#listenercount)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:579
-
-___
-
-### listeners
-
-▸ **listeners**(`eventName`): `Function`[]
-
-Returns a copy of the array of listeners for the event named `eventName`.
-
-```js
-server.on('connection', (stream) => {
-  console.log('someone connected!');
-});
-console.log(util.inspect(server.listeners('connection')));
-// Prints: [ [Function] ]
-```
-
-**`since`** v0.1.26
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `eventName` | `string` \| `symbol` |
-
-#### Returns
-
-`Function`[]
-
-#### Inherited from
-
-[Input](../wiki/Input).[listeners](../wiki/Input#listeners)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:502
-
-___
-
-### next
-
-▸ **next**(`type?`): `Promise`<`IteratorResult`<[`Increment`](../wiki/Increment), `any`\>\>
-
-Resolves on the next change to this input's state.
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `type` | ``"change"`` \| ``"press"`` \| ``"release"`` | `"change"` |
-
-#### Returns
-
-`Promise`<`IteratorResult`<[`Increment`](../wiki/Increment), `any`\>\>
-
-#### Inherited from
-
-[Input](../wiki/Input).[next](../wiki/Input#next)
-
-#### Defined in
-
-[src/input.ts:78](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L78)
-
-___
-
-### off
-
-▸ **off**(`eventName`, `listener`): [`Increment`](../wiki/Increment)
-
-Alias for `emitter.removeListener()`.
-
-**`since`** v10.0.0
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `eventName` | `string` \| `symbol` |
-| `listener` | (...`args`: `any`[]) => `void` |
-
-#### Returns
-
-[`Increment`](../wiki/Increment)
-
-#### Inherited from
-
-[Input](../wiki/Input).[off](../wiki/Input#off)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:462
-
-___
-
-### on
-
-▸ **on**(`event`, `listener`): [`Increment`](../wiki/Increment)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `event` | [`InputEvent`](../wiki/Exports#inputevent) |
-| `listener` | (`input`: [`Input`](../wiki/Input)<`number`\>, `changed`: [`Input`](../wiki/Input)<`unknown`\>) => `unknown` |
-
-#### Returns
-
-[`Increment`](../wiki/Increment)
-
-#### Inherited from
-
-[Input](../wiki/Input).[on](../wiki/Input#on)
-
-#### Defined in
-
-[src/input.ts:37](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L37)
-
-___
-
-### once
-
-▸ **once**(`eventName`, `listener`): [`Increment`](../wiki/Increment)
-
-Adds a **one-time**`listener` function for the event named `eventName`. The
-next time `eventName` is triggered, this listener is removed and then invoked.
-
-```js
-server.once('connection', (stream) => {
-  console.log('Ah, we have our first user!');
-});
-```
-
-Returns a reference to the `EventEmitter`, so that calls can be chained.
-
-By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the
-event listener to the beginning of the listeners array.
-
-```js
-const myEE = new EventEmitter();
-myEE.once('foo', () => console.log('a'));
-myEE.prependOnceListener('foo', () => console.log('b'));
-myEE.emit('foo');
-// Prints:
-//   b
-//   a
-```
-
-**`since`** v0.3.0
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` \| `symbol` | The name of the event. |
-| `listener` | (...`args`: `any`[]) => `void` | The callback function |
-
-#### Returns
-
-[`Increment`](../wiki/Increment)
-
-#### Inherited from
-
-[Input](../wiki/Input).[once](../wiki/Input#once)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:377
-
-___
-
-### prependListener
-
-▸ **prependListener**(`eventName`, `listener`): [`Increment`](../wiki/Increment)
-
-Adds the `listener` function to the _beginning_ of the listeners array for the
-event named `eventName`. No checks are made to see if the `listener` has
-already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple
-times.
-
-```js
-server.prependListener('connection', (stream) => {
-  console.log('someone connected!');
-});
-```
-
-Returns a reference to the `EventEmitter`, so that calls can be chained.
-
-**`since`** v6.0.0
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` \| `symbol` | The name of the event. |
-| `listener` | (...`args`: `any`[]) => `void` | The callback function |
-
-#### Returns
-
-[`Increment`](../wiki/Increment)
-
-#### Inherited from
-
-[Input](../wiki/Input).[prependListener](../wiki/Input#prependlistener)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:597
-
-___
-
-### prependOnceListener
-
-▸ **prependOnceListener**(`eventName`, `listener`): [`Increment`](../wiki/Increment)
-
-Adds a **one-time**`listener` function for the event named `eventName` to the_beginning_ of the listeners array. The next time `eventName` is triggered, this
-listener is removed, and then invoked.
-
-```js
-server.prependOnceListener('connection', (stream) => {
-  console.log('Ah, we have our first user!');
-});
-```
-
-Returns a reference to the `EventEmitter`, so that calls can be chained.
-
-**`since`** v6.0.0
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` \| `symbol` | The name of the event. |
-| `listener` | (...`args`: `any`[]) => `void` | The callback function |
-
-#### Returns
-
-[`Increment`](../wiki/Increment)
-
-#### Inherited from
-
-[Input](../wiki/Input).[prependOnceListener](../wiki/Input#prependoncelistener)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:613
-
-___
-
-### promise
-
-▸ **promise**(`type?`): `Promise`<[`Increment`](../wiki/Increment)\>
-
-Resolves on the next change to this input's state.
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `type` | ``"change"`` \| ``"press"`` \| ``"release"`` | `"change"` |
-
-#### Returns
-
-`Promise`<[`Increment`](../wiki/Increment)\>
-
-#### Inherited from
-
-[Input](../wiki/Input).[promise](../wiki/Input#promise)
-
-#### Defined in
-
-[src/input.ts:91](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L91)
-
-___
-
-### rawListeners
-
-▸ **rawListeners**(`eventName`): `Function`[]
-
-Returns a copy of the array of listeners for the event named `eventName`,
-including any wrappers (such as those created by `.once()`).
-
-```js
-const emitter = new EventEmitter();
-emitter.once('log', () => console.log('log once'));
-
-// Returns a new Array with a function `onceWrapper` which has a property
-// `listener` which contains the original listener bound above
-const listeners = emitter.rawListeners('log');
-const logFnWrapper = listeners[0];
-
-// Logs "log once" to the console and does not unbind the `once` event
-logFnWrapper.listener();
-
-// Logs "log once" to the console and removes the listener
-logFnWrapper();
-
-emitter.on('log', () => console.log('log persistently'));
-// Will return a new Array with a single function bound by `.on()` above
-const newListeners = emitter.rawListeners('log');
-
-// Logs "log persistently" twice
-newListeners[0]();
-emitter.emit('log');
-```
-
-**`since`** v9.4.0
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `eventName` | `string` \| `symbol` |
-
-#### Returns
-
-`Function`[]
-
-#### Inherited from
-
-[Input](../wiki/Input).[rawListeners](../wiki/Input#rawlisteners)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:532
-
-___
-
-### removeAllListeners
-
-▸ **removeAllListeners**(`event?`): [`Increment`](../wiki/Increment)
-
-Removes all listeners, or those of the specified `eventName`.
-
-It is bad practice to remove listeners added elsewhere in the code,
-particularly when the `EventEmitter` instance was created by some other
-component or module (e.g. sockets or file streams).
-
-Returns a reference to the `EventEmitter`, so that calls can be chained.
-
-**`since`** v0.1.26
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `event?` | `string` \| `symbol` |
-
-#### Returns
-
-[`Increment`](../wiki/Increment)
-
-#### Inherited from
-
-[Input](../wiki/Input).[removeAllListeners](../wiki/Input#removealllisteners)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:473
-
-___
-
-### removeListener
-
-▸ **removeListener**(`eventName`, `listener`): [`Increment`](../wiki/Increment)
-
-Removes the specified `listener` from the listener array for the event named`eventName`.
-
-```js
-const callback = (stream) => {
-  console.log('someone connected!');
-};
-server.on('connection', callback);
-// ...
-server.removeListener('connection', callback);
-```
-
-`removeListener()` will remove, at most, one instance of a listener from the
-listener array. If any single listener has been added multiple times to the
-listener array for the specified `eventName`, then `removeListener()` must be
-called multiple times to remove each instance.
-
-Once an event is emitted, all listeners attached to it at the
-time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and_before_ the last listener finishes execution will
-not remove them from`emit()` in progress. Subsequent events behave as expected.
-
-```js
-const myEmitter = new MyEmitter();
-
-const callbackA = () => {
-  console.log('A');
-  myEmitter.removeListener('event', callbackB);
-};
-
-const callbackB = () => {
-  console.log('B');
-};
-
-myEmitter.on('event', callbackA);
-
-myEmitter.on('event', callbackB);
-
-// callbackA removes listener callbackB but it will still be called.
-// Internal listener array at time of emit [callbackA, callbackB]
-myEmitter.emit('event');
-// Prints:
-//   A
-//   B
-
-// callbackB is now removed.
-// Internal listener array [callbackA]
-myEmitter.emit('event');
-// Prints:
-//   A
-```
-
-Because listeners are managed using an internal array, calling this will
-change the position indices of any listener registered _after_ the listener
-being removed. This will not impact the order in which listeners are called,
-but it means that any copies of the listener array as returned by
-the `emitter.listeners()` method will need to be recreated.
-
-When a single function has been added as a handler multiple times for a single
-event (as in the example below), `removeListener()` will remove the most
-recently added instance. In the example the `once('ping')`listener is removed:
-
-```js
-const ee = new EventEmitter();
-
-function pong() {
-  console.log('pong');
-}
-
-ee.on('ping', pong);
-ee.once('ping', pong);
-ee.removeListener('ping', pong);
-
-ee.emit('ping');
-ee.emit('ping');
-```
-
-Returns a reference to the `EventEmitter`, so that calls can be chained.
-
-**`since`** v0.1.26
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `eventName` | `string` \| `symbol` |
-| `listener` | (...`args`: `any`[]) => `void` |
-
-#### Returns
-
-[`Increment`](../wiki/Increment)
-
-#### Inherited from
-
-[Input](../wiki/Input).[removeListener](../wiki/Input#removelistener)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:457
-
-___
-
-### setMaxListeners
-
-▸ **setMaxListeners**(`n`): [`Increment`](../wiki/Increment)
-
-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 `emitter.setMaxListeners()` method allows the limit to be
-modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners.
-
-Returns a reference to the `EventEmitter`, so that calls can be chained.
-
-**`since`** v0.3.5
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `n` | `number` |
-
-#### Returns
-
-[`Increment`](../wiki/Increment)
-
-#### Inherited from
-
-[Input](../wiki/Input).[setMaxListeners](../wiki/Input#setmaxlisteners)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:483
-
-___
-
-### toString
-
-▸ **toString**(): `string`
-
-Render a convenient debugging string.
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[Input](../wiki/Input).[toString](../wiki/Input#tostring)
-
-#### Defined in
-
-[src/input.ts:102](https://github.com/nsfm/dualsense-ts/blob/e429a3c/src/input.ts#L102)
-
-___
-
-### getEventListeners
-
-▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[]
-
-Returns a copy of the array of listeners for the event named `eventName`.
-
-For `EventEmitter`s this behaves exactly the same as calling `.listeners` on
-the emitter.
-
-For `EventTarget`s this is the only way to get the event listeners for the
-event target. This is useful for debugging and diagnostic purposes.
-
-```js
-const { getEventListeners, EventEmitter } = require('events');
-
-{
-  const ee = new EventEmitter();
-  const listener = () => console.log('Events are fun');
-  ee.on('foo', listener);
-  getEventListeners(ee, 'foo'); // [listener]
-}
-{
-  const et = new EventTarget();
-  const listener = () => console.log('Events are fun');
-  et.addEventListener('foo', listener);
-  getEventListeners(et, 'foo'); // [listener]
-}
-```
-
-**`since`** v15.2.0, v14.17.0
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `emitter` | `EventEmitter` \| `DOMEventTarget` |
-| `name` | `string` \| `symbol` |
-
-#### Returns
-
-`Function`[]
-
-#### Inherited from
-
-[Input](../wiki/Input).[getEventListeners](../wiki/Input#geteventlisteners)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:262
-
-___
-
-### listenerCount
-
-▸ `Static` **listenerCount**(`emitter`, `eventName`): `number`
-
-A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`.
-
-```js
-const { EventEmitter, listenerCount } = require('events');
-const myEmitter = new EventEmitter();
-myEmitter.on('event', () => {});
-myEmitter.on('event', () => {});
-console.log(listenerCount(myEmitter, 'event'));
-// Prints: 2
-```
-
-**`since`** v0.9.12
-
-**`deprecated`** Since v3.2.0 - Use `listenerCount` instead.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `emitter` | `EventEmitter` | The emitter to query |
-| `eventName` | `string` \| `symbol` | The event name |
-
-#### Returns
-
-`number`
-
-#### Inherited from
-
-[Input](../wiki/Input).[listenerCount](../wiki/Input#listenercount-1)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:234
-
-___
-
-### on
-
-▸ `Static` **on**(`emitter`, `eventName`, `options?`): `AsyncIterableIterator`<`any`\>
-
-```js
-const { on, EventEmitter } = require('events');
-
-(async () => {
-  const ee = new EventEmitter();
-
-  // Emit later on
-  process.nextTick(() => {
-    ee.emit('foo', 'bar');
-    ee.emit('foo', 42);
-  });
-
-  for await (const event of on(ee, 'foo')) {
-    // The execution of this inner block is synchronous and it
-    // processes one event at a time (even with await). Do not use
-    // if concurrent execution is required.
-    console.log(event); // prints ['bar'] [42]
-  }
-  // Unreachable here
-})();
-```
-
-Returns an `AsyncIterator` that iterates `eventName` events. It will throw
-if the `EventEmitter` emits `'error'`. It removes all listeners when
-exiting the loop. The `value` returned by each iteration is an array
-composed of the emitted event arguments.
-
-An `AbortSignal` can be used to cancel waiting on events:
-
-```js
-const { on, EventEmitter } = require('events');
-const ac = new AbortController();
-
-(async () => {
-  const ee = new EventEmitter();
-
-  // Emit later on
-  process.nextTick(() => {
-    ee.emit('foo', 'bar');
-    ee.emit('foo', 42);
-  });
-
-  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
-    // The execution of this inner block is synchronous and it
-    // processes one event at a time (even with await). Do not use
-    // if concurrent execution is required.
-    console.log(event); // prints ['bar'] [42]
-  }
-  // Unreachable here
-})();
-
-process.nextTick(() => ac.abort());
-```
-
-**`since`** v13.6.0, v12.16.0
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `emitter` | `EventEmitter` | - |
-| `eventName` | `string` | The name of the event being listened for |
-| `options?` | `StaticEventEmitterOptions` | - |
-
-#### Returns
-
-`AsyncIterableIterator`<`any`\>
-
-that iterates `eventName` events emitted by the `emitter`
-
-#### Inherited from
-
-[Input](../wiki/Input).[on](../wiki/Input#on-1)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:217
-
-___
-
-### once
-
-▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
-
-Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
-event or that is rejected if the `EventEmitter` emits `'error'` while waiting.
-The `Promise` will resolve with an array of all the arguments emitted to the
-given event.
-
-This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event
-semantics and does not listen to the `'error'` event.
-
-```js
-const { once, EventEmitter } = require('events');
-
-async function run() {
-  const ee = new EventEmitter();
-
-  process.nextTick(() => {
-    ee.emit('myevent', 42);
-  });
-
-  const [value] = await once(ee, 'myevent');
-  console.log(value);
-
-  const err = new Error('kaboom');
-  process.nextTick(() => {
-    ee.emit('error', err);
-  });
-
-  try {
-    await once(ee, 'myevent');
-  } catch (err) {
-    console.log('error happened', err);
-  }
-}
-
-run();
-```
-
-The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the
-'`error'` event itself, then it is treated as any other kind of event without
-special handling:
-
-```js
-const { EventEmitter, once } = require('events');
-
-const ee = new EventEmitter();
-
-once(ee, 'error')
-  .then(([err]) => console.log('ok', err.message))
-  .catch((err) => console.log('error', err.message));
-
-ee.emit('error', new Error('boom'));
-
-// Prints: ok boom
-```
-
-An `AbortSignal` can be used to cancel waiting for the event:
-
-```js
-const { EventEmitter, once } = require('events');
-
-const ee = new EventEmitter();
-const ac = new AbortController();
-
-async function foo(emitter, event, signal) {
-  try {
-    await once(emitter, event, { signal });
-    console.log('event emitted!');
-  } catch (error) {
-    if (error.name === 'AbortError') {
-      console.error('Waiting for the event was canceled!');
-    } else {
-      console.error('There was an error', error.message);
-    }
-  }
-}
-
-foo(ee, 'foo', ac.signal);
-ac.abort(); // Abort waiting for the event
-ee.emit('foo'); // Prints: Waiting for the event was canceled!
-```
-
-**`since`** v11.13.0, v10.16.0
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `emitter` | `NodeEventTarget` |
-| `eventName` | `string` \| `symbol` |
-| `options?` | `StaticEventEmitterOptions` |
-
-#### Returns
-
-`Promise`<`any`[]\>
-
-#### Inherited from
-
-[Input](../wiki/Input).[once](../wiki/Input#once-1)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:157
-
-▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `emitter` | `DOMEventTarget` |
-| `eventName` | `string` |
-| `options?` | `StaticEventEmitterOptions` |
-
-#### Returns
-
-`Promise`<`any`[]\>
-
-#### Inherited from
-
-[Input](../wiki/Input).[once](../wiki/Input#once-1)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:158
-
-___
-
-### setMaxListeners
-
-▸ `Static` **setMaxListeners**(`n?`, ...`eventTargets`): `void`
-
-```js
-const {
-  setMaxListeners,
-  EventEmitter
-} = require('events');
-
-const target = new EventTarget();
-const emitter = new EventEmitter();
-
-setMaxListeners(5, target, emitter);
-```
-
-**`since`** v15.4.0
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. |
-| `...eventTargets` | (`EventEmitter` \| `DOMEventTarget`)[] | - |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[Input](../wiki/Input).[setMaxListeners](../wiki/Input#setmaxlisteners-1)
-
-#### Defined in
-
-node_modules/@types/node/events.d.ts:280