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()

addListener(eventName, listener)

1
addListener<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>): this

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
`listener`	`Exclude`<`InternalAsyncEventEmitterInternalListenerForEvent`<`AsyncEventEmitter`<`U`>, `K`, `U`>[`"listener"`], `undefined`>

Returns

this

Inherited from

AsyncEventEmitter.addListener

Source

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

addListener(eventName, listener)

1
addListener<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>): this

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
`listener`	`Exclude`<`InternalAsyncEventEmitterInternalListenerForEvent`<`AsyncEventEmitter`<`U`>, `K`, `U`>[`"listener"`], `undefined`>

Returns

this

Inherited from

AsyncEventEmitter.addListener

Source

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

emit()

emit(eventName, args)

1
emit<K>(eventName: K, ...args: InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<U>, K, U>): boolean

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
…`args`	`InternalGetAsyncEventEmitterEventParameters`<`AsyncEventEmitter`<`U`>, `K`, `U`>

Returns

boolean

Inherited from

AsyncEventEmitter.emit

Source

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

emit(eventName, args)

1
emit<K>(eventName: K, ...args: InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<U>, K, U>): boolean

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
…`args`	`InternalGetAsyncEventEmitterEventParameters`<`AsyncEventEmitter`<`U`>, `K`, `U`>

Returns

boolean

Inherited from

AsyncEventEmitter.emit

Source

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

eventNames()

1
eventNames(): (string | symbol)[] & keyof AsyncEventEmitterPredefinedEvents[] & keyof U[]

Returns

(string | symbol)[] & keyof AsyncEventEmitterPredefinedEvents[] & keyof U[]

Inherited from

AsyncEventEmitter.eventNames

Source

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

getMaxListeners()

1
getMaxListeners(): number

Returns

number

Inherited from

AsyncEventEmitter.getMaxListeners

Source

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

listenerCount()

listenerCount(eventName)

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:39

listenerCount(eventName)

1
listenerCount(eventName: string | symbol): number

Parameters

Parameter	Type
`eventName`	`string` \| `symbol`

Returns

number

Inherited from

AsyncEventEmitter.listenerCount

Source

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

listeners()

listeners(eventName)

1
listeners<K>(eventName: K): Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>[]

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`

Returns

Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>[]

Inherited from

AsyncEventEmitter.listeners

Source

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

listeners(eventName)

1
listeners<K>(eventName: K): Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>[]

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`

Returns

Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>[]

Inherited from

AsyncEventEmitter.listeners

Source

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

off()

off(eventName, listener)

1
off<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>): this

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
`listener`	`Exclude`<`InternalAsyncEventEmitterInternalListenerForEvent`<`AsyncEventEmitter`<`U`>, `K`, `U`>[`"listener"`], `undefined`>

Returns

this

Inherited from

AsyncEventEmitter.off

Source

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

off(eventName, listener)

1
off<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>): this

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
`listener`	`Exclude`<`InternalAsyncEventEmitterInternalListenerForEvent`<`AsyncEventEmitter`<`U`>, `K`, `U`>[`"listener"`], `undefined`>

Returns

this

Inherited from

AsyncEventEmitter.off

Source

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

on()

on(eventName, listener)

1
on<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>): this

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
`listener`	`Exclude`<`InternalAsyncEventEmitterInternalListenerForEvent`<`AsyncEventEmitter`<`U`>, `K`, `U`>[`"listener"`], `undefined`>

Returns

this

Inherited from

AsyncEventEmitter.on

Source

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

on(eventName, listener)

1
on<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>): this

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
`listener`	`Exclude`<`InternalAsyncEventEmitterInternalListenerForEvent`<`AsyncEventEmitter`<`U`>, `K`, `U`>[`"listener"`], `undefined`>

Returns

this

Inherited from

AsyncEventEmitter.on

Source

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

once()

once(eventName, listener)

1
once<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>): this

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
`listener`	`Exclude`<`InternalAsyncEventEmitterInternalListenerForEvent`<`AsyncEventEmitter`<`U`>, `K`, `U`>[`"listener"`], `undefined`>

Returns

this

Inherited from

AsyncEventEmitter.once

Source

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

once(eventName, listener)

1
once<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>): this

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
`listener`	`Exclude`<`InternalAsyncEventEmitterInternalListenerForEvent`<`AsyncEventEmitter`<`U`>, `K`, `U`>[`"listener"`], `undefined`>

Returns

this

Inherited from

AsyncEventEmitter.once

Source

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

prependListener()

prependListener(eventName, listener)

1
prependListener<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>): this

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
`listener`	`Exclude`<`InternalAsyncEventEmitterInternalListenerForEvent`<`AsyncEventEmitter`<`U`>, `K`, `U`>[`"listener"`], `undefined`>

Returns

this

Inherited from

AsyncEventEmitter.prependListener

Source

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

prependListener(eventName, listener)

1
prependListener<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>): this

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
`listener`	`Exclude`<`InternalAsyncEventEmitterInternalListenerForEvent`<`AsyncEventEmitter`<`U`>, `K`, `U`>[`"listener"`], `undefined`>

Returns

this

Inherited from

AsyncEventEmitter.prependListener

Source

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

prependOnceListener()

prependOnceListener(eventName, listener)

1
prependOnceListener<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>): this

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
`listener`	`Exclude`<`InternalAsyncEventEmitterInternalListenerForEvent`<`AsyncEventEmitter`<`U`>, `K`, `U`>[`"listener"`], `undefined`>

Returns

this

Inherited from

AsyncEventEmitter.prependOnceListener

Source

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

prependOnceListener(eventName, listener)

1
prependOnceListener<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>): this

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
`listener`	`Exclude`<`InternalAsyncEventEmitterInternalListenerForEvent`<`AsyncEventEmitter`<`U`>, `K`, `U`>[`"listener"`], `undefined`>

Returns

this

Inherited from

AsyncEventEmitter.prependOnceListener

Source

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

rawListeners()

rawListeners(eventName)

1
rawListeners<K>(eventName: K): InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>[]

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`

Returns

InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>[]

Inherited from

AsyncEventEmitter.rawListeners

Source

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

rawListeners(eventName)

1
rawListeners<K>(eventName: K): InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>[]

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`

Returns

InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>[]

Inherited from

AsyncEventEmitter.rawListeners

Source

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

removeAllListeners()

removeAllListeners(event)

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:27

removeAllListeners(event)

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:28

removeAllListeners(event)

1
removeAllListeners(event: string | symbol): this

Parameters

Parameter	Type
`event`	`string` \| `symbol`

Returns

this

Inherited from

AsyncEventEmitter.removeAllListeners

Source

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

removeAllListeners(event)

1
removeAllListeners(event?: string | symbol): this

Parameters

Parameter	Type
`event`?	`string` \| `symbol`

Returns

this

Inherited from

AsyncEventEmitter.removeAllListeners

Source

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

removeListener()

removeListener(eventName, listener)

1
removeListener<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>): this

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
`listener`	`Exclude`<`InternalAsyncEventEmitterInternalListenerForEvent`<`AsyncEventEmitter`<`U`>, `K`, `U`>[`"listener"`], `undefined`>

Returns

this

Inherited from

AsyncEventEmitter.removeListener

Source

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

removeListener(eventName, listener)

1
removeListener<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>): this

Type parameters

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

Parameters

Parameter	Type
`eventName`	`K`
`listener`	`Exclude`<`InternalAsyncEventEmitterInternalListenerForEvent`<`AsyncEventEmitter`<`U`>, `K`, `U`>[`"listener"`], `undefined`>

Returns

this

Inherited from

AsyncEventEmitter.removeListener

Source

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

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:31

waitForAllListenersToComplete()

1
waitForAllListenersToComplete(): Promise<boolean>

Returns

Promise<boolean>

Inherited from

AsyncEventEmitter.waitForAllListenersToComplete

Source

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

listenerCount()

listenerCount(emitter, eventName)

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

Type parameters

Type parameter	Value
`EventMap` extends `object`	-
`EventName` extends `PropertyKey`	keyof `EventMap` \| keyof AsyncEventEmitterPredefinedEvents

Parameters

Parameter	Type
`emitter`	`AsyncEventEmitter`<`EventMap`>
`eventName`	`EventName` \| keyof AsyncEventEmitterPredefinedEvents

Returns

number

Inherited from

AsyncEventEmitter.listenerCount

Source

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

listenerCount(emitter, eventName)

1
static listenerCount(emitter: AsyncEventEmitter<any>, eventName: string | symbol): number

Parameters

Parameter	Type
`emitter`	`AsyncEventEmitter`<`any`>
`eventName`	`string` \| `symbol`

Returns

number

Inherited from

AsyncEventEmitter.listenerCount

Source

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

on()

on(emitter, eventName, options)

1
static on<EventMap, EventName>(
2
   emitter: AsyncEventEmitter<EventMap>,
3
   eventName: EventName,
4
options?: AbortableMethods): AsyncGenerator<InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<EventMap>, EventName, EventMap>, void, unknown>

Type parameters

Type parameter	Value
`EventMap` extends `object`	-
`EventName` extends `PropertyKey`	keyof AsyncEventEmitterPredefinedEvents \| keyof `EventMap`

Parameters

Parameter	Type
`emitter`	`AsyncEventEmitter`<`EventMap`>
`eventName`	`EventName`
`options`?	`AbortableMethods`

Returns

AsyncGenerator<InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<EventMap>, EventName, EventMap>, void, unknown>

Inherited from

AsyncEventEmitter.on

Source

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

on(emitter, eventName, options)

1
static on(
2
   emitter: AsyncEventEmitter<any>,
3
   eventName: string | symbol,
4
options?: AbortableMethods): AsyncGenerator<any[], void, unknown>

Parameters

Parameter	Type
`emitter`	`AsyncEventEmitter`<`any`>
`eventName`	`string` \| `symbol`
`options`?	`AbortableMethods`

Returns

AsyncGenerator<any[], void, unknown>

Inherited from

AsyncEventEmitter.on

Source

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

once()

once(emitter, eventName, options)

1
static once<EventMap, EventName>(
2
   emitter: AsyncEventEmitter<EventMap>,
3
   eventName: EventName,
4
options?: AbortableMethods): Promise<InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<EventMap>, EventName, EventMap>>

Type parameters

Type parameter	Value
`EventMap` extends `object`	-
`EventName` extends `PropertyKey`	keyof AsyncEventEmitterPredefinedEvents \| keyof `EventMap`

Parameters

Parameter	Type
`emitter`	`AsyncEventEmitter`<`EventMap`>
`eventName`	`EventName`
`options`?	`AbortableMethods`

Returns

Promise<InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<EventMap>, EventName, EventMap>>

Inherited from

AsyncEventEmitter.once

Source

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

once(emitter, eventName, options)

1
static once(
2
   emitter: AsyncEventEmitter<any>,
3
   eventName: string | symbol,
4
options?: AbortableMethods): Promise<any[]>

Parameters

Parameter	Type
`emitter`	`AsyncEventEmitter`<`any`>
`eventName`	`string` \| `symbol`
`options`?	`AbortableMethods`

Returns

Promise<any[]>

Inherited from

AsyncEventEmitter.once

Source

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