EventSubEventEmitter

The EventSub Event Emitter of any type of connection.

Extends

AsyncEventEmitter<U>

Extended by

BaseConnection

Type parameters

Type parameter
`U` extends `WebhookEvents` \| `WebSocketEvents` \| `ConduitEvents`

Constructors

new EventSubEventEmitter()

1
new EventSubEventEmitter<U>(): EventSubEventEmitter<U>

Builds up a EventSub Event Emitter.

Returns

EventSubEventEmitter<U>

Overrides

AsyncEventEmitter<U>.constructor

Source

twitchfy/packages/eventsub/src/structures/BaseConnection.ts:20

Methods

addListener()

1
addListener<K>(eventName: K, listener: (...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : U[K]) => void): this

Type parameters

Type parameter
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`eventName`	`K`
`listener`	(…`args`: `K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `U`[`K`]) => `void`

Returns

this

Inherited from

AsyncEventEmitter.addListener

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:7

emit()

1
emit<K>(eventName: K, ...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : U[K]): boolean

Type parameters

Type parameter
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`eventName`	`K`
…`args`	`K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `U`[`K`]

Returns

boolean

Inherited from

AsyncEventEmitter.emit

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:17

eventNames()

1
eventNames(): (keyof AsyncEventEmitterPredefinedEvents | keyof U)[]

Returns

(keyof AsyncEventEmitterPredefinedEvents | keyof U)[]

Inherited from

AsyncEventEmitter.eventNames

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:21

getMaxListeners()

1
getMaxListeners(): number

Returns

number

Inherited from

AsyncEventEmitter.getMaxListeners

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:14

listenerCount()

1
listenerCount<K>(eventName: K): number

Type parameters

Type parameter
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`eventName`	`K`

Returns

number

Inherited from

AsyncEventEmitter.listenerCount

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:18

listeners()

1
listeners<K>(eventName: K): (...args: U[keyof U]) => Awaitable<void>[]

Type parameters

Type parameter
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`eventName`	`K`

Returns

(…args: U[keyof U]) => Awaitable<void>[]

Inherited from

AsyncEventEmitter.listeners

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:15

off()

1
off<K>(eventName: K, listener: (...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : U[K]) => void): this

Type parameters

Type parameter
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`eventName`	`K`
`listener`	(…`args`: `K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `U`[`K`]) => `void`

Returns

this

Inherited from

AsyncEventEmitter.off

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:11

on()

1
on<K>(eventName: K, listener: (...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : U[K]) => void): this

Type parameters

Type parameter
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`eventName`	`K`
`listener`	(…`args`: `K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `U`[`K`]) => `void`

Returns

this

Inherited from

AsyncEventEmitter.on

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:8

once()

1
once<K>(eventName: K, listener: (...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : U[K]) => void): this

Type parameters

Type parameter
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`eventName`	`K`
`listener`	(…`args`: `K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `U`[`K`]) => `void`

Returns

this

Inherited from

AsyncEventEmitter.once

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:9

prependListener()

1
prependListener<K>(eventName: K, listener: (...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : U[K]) => void): this

Type parameters

Type parameter
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`eventName`	`K`
`listener`	(…`args`: `K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `U`[`K`]) => `void`

Returns

this

Inherited from

AsyncEventEmitter.prependListener

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:19

prependOnceListener()

1
prependOnceListener<K>(eventName: K, listener: (...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : U[K]) => void): this

Type parameters

Type parameter
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`eventName`	`K`
`listener`	(…`args`: `K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `U`[`K`]) => `void`

Returns

this

Inherited from

AsyncEventEmitter.prependOnceListener

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:20

rawListeners()

1
rawListeners<K>(eventName: K): Listener<U[keyof U]>[]

Type parameters

Type parameter
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`eventName`	`K`

Returns

Listener<U[keyof U]>[]

Inherited from

AsyncEventEmitter.rawListeners

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:16

removeAllListeners()

1
removeAllListeners<K>(event?: K): this

Type parameters

Type parameter
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`event`?	`K`

Returns

this

Inherited from

AsyncEventEmitter.removeAllListeners

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:12

removeListener()

1
removeListener<K>(eventName: K, listener: (...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : U[K]) => void): this

Type parameters

Type parameter
`K` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`eventName`	`K`
`listener`	(…`args`: `K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `U`[`K`]) => `void`

Returns

this

Inherited from

AsyncEventEmitter.removeListener

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:10

setMaxListeners()

1
setMaxListeners(n: number): this

Parameters

Parameter	Type
`n`	`number`

Returns

this

Inherited from

AsyncEventEmitter.setMaxListeners

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:13

waitForAllListenersToComplete()

1
waitForAllListenersToComplete(): Promise<boolean>

Returns

Promise<boolean>

Inherited from

AsyncEventEmitter.waitForAllListenersToComplete

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:22

listenerCount()

1
static listenerCount<Emitter, EventNames, EventName>(emitter: Emitter, eventName: keyof AsyncEventEmitterPredefinedEvents | EventName): number

Type parameters

Type parameter	Value
`Emitter` extends `AsyncEventEmitter`<`any`, `any`>	-
`EventNames`	`Emitter` extends `AsyncEventEmitter`<`Events`, `Events`> ? `Events` : `never`
`EventName` extends `PropertyKey`	`EventNames` extends `never` ? `string` \| `symbol` : keyof `EventNames`

Parameters

Parameter	Type
`emitter`	`Emitter`
`eventName`	keyof AsyncEventEmitterPredefinedEvents \| `EventName`

Returns

number

Inherited from

AsyncEventEmitter.listenerCount

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:25

on()

1
static on<Emitter, EventNames, EventName, EventResult>(
2
   emitter: Emitter,
3
   eventName: EventName,
4
options?: AbortableMethods): AsyncGenerator<EventResult, void, unknown>

Type parameters

Type parameter	Value
`Emitter` extends `AsyncEventEmitter`<`any`, `any`>	-
`EventNames` extends `object`	`Emitter` extends `AsyncEventEmitter`<`Events`, `any`> ? `Events` : `Record`<`PropertyKey`, `unknown`[]>
`EventName` extends `PropertyKey`	keyof AsyncEventEmitterPredefinedEvents \| keyof `EventNames`
`EventResult` extends `unknown`[]	`EventNames` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`EventName`] : `EventNames`[`EventName`]

Parameters

Parameter	Type
`emitter`	`Emitter`
`eventName`	`EventName`
`options`?	`AbortableMethods`

Returns

AsyncGenerator<EventResult, void, unknown>

Inherited from

AsyncEventEmitter.on

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:29

once()

1
static once<Emitter, EventNames, EventName, EventResult>(
2
   emitter: Emitter,
3
   eventName: EventName,
4
options?: AbortableMethods): Promise<EventResult>

Type parameters

Type parameter	Value
`Emitter` extends `AsyncEventEmitter`<`any`, `any`>	-
`EventNames` extends `object`	`Emitter` extends `AsyncEventEmitter`<`Events`, `any`> ? `Events` : `Record`<`PropertyKey`, `unknown`[]>
`EventName` extends `PropertyKey`	keyof AsyncEventEmitterPredefinedEvents \| keyof `EventNames`
`EventResult` extends `unknown`[]	`EventNames` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`EventName`] : `EventNames`[`EventName`]

Parameters

Parameter	Type
`emitter`	`Emitter`
`eventName`	`EventName`
`options`?	`AbortableMethods`

Returns

Promise<EventResult>

Inherited from

AsyncEventEmitter.once

Source

twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:27