Skip to content

BaseConnection

The base class for all the connections.

Extends

Extended by

Type parameters

Type parameter
K extends ConnectionTypes
U extends WebhookEvents | WebSocketEvents | ConduitEvents

Constructors

new BaseConnection()

1
new BaseConnection<K, U>(options: BaseConnectionOptions<K>): BaseConnection<K, U>

Builds up a BaseConnection.

Parameters

ParameterTypeDescription
optionsBaseConnectionOptions<K>The options of the connection.

Returns

BaseConnection<K, U>

Overrides

EventSubEventEmitter.constructor

Source

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

Properties

PropertyModifierTypeDescription
clientIdreadonlystringThe client ID of the connection.
clientSecretreadonlystringThe client secret of the connection.
debugpublicbooleanWhether the connection is in debug mode or not.
helixClientreadonlyHelixClientThe Helix client used by the connection for making API Requests.
loggerreadonlyLoggerThe logger of the connection.
maintainSubscriptionsreadonlybooleanWhether the connection should maintain the subscriptions or not between each start.
storagereadonlyStorageAdapter<K>The storage adapter used by the connection for storing subscriptions.
subscriptionsreadonlySubscriptionCollection<K, SubscriptionTypes>The subscriptions of the connection. You will only receive events for this subscriptions.

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
ParameterType
eventNameK
listenerExclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>
Returns

this

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
listenerExclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>
Returns

this

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
argsInternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<U>, K, U>
Returns

boolean

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
argsInternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<U>, K, U>
Returns

boolean

Inherited from

EventSubEventEmitter.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

EventSubEventEmitter.eventNames

Source

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


getMaxListeners()

1
getMaxListeners(): number

Returns

number

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
Returns

number

Inherited from

EventSubEventEmitter.listenerCount

Source

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

listenerCount(eventName)

1
listenerCount(eventName: string | symbol): number
Parameters
ParameterType
eventNamestring | symbol
Returns

number

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
Returns

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

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
Returns

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

Inherited from

EventSubEventEmitter.listeners

Source

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


makeDebug()

1
makeDebug(...args: any[]): void

Makes a debug log

Parameters

ParameterTypeDescription
argsany[]The arguments to log.

Returns

void

Source

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


makeWarn()

1
makeWarn(...args: any[]): void

Makes a warn log

Parameters

ParameterTypeDescription
argsany[]The arguments to log.

Returns

void

Source

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


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
ParameterType
eventNameK
listenerExclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>
Returns

this

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
listenerExclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>
Returns

this

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
listenerExclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>
Returns

this

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
listenerExclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>
Returns

this

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
listenerExclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>
Returns

this

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
listenerExclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>
Returns

this

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
listenerExclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>
Returns

this

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
listenerExclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>
Returns

this

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
listenerExclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>
Returns

this

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
listenerExclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>
Returns

this

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
Returns

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

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
Returns

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

Inherited from

EventSubEventEmitter.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
ParameterType
eventK
Returns

this

Inherited from

EventSubEventEmitter.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
ParameterType
event?K
Returns

this

Inherited from

EventSubEventEmitter.removeAllListeners

Source

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

removeAllListeners(event)

1
removeAllListeners(event: string | symbol): this
Parameters
ParameterType
eventstring | symbol
Returns

this

Inherited from

EventSubEventEmitter.removeAllListeners

Source

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

removeAllListeners(event)

1
removeAllListeners(event?: string | symbol): this
Parameters
ParameterType
event?string | symbol
Returns

this

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
listenerExclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>
Returns

this

Inherited from

EventSubEventEmitter.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
ParameterType
eventNameK
listenerExclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<U>, K, U>["listener"], undefined>
Returns

this

Inherited from

EventSubEventEmitter.removeListener

Source

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


setMaxListeners()

1
setMaxListeners(n: number): this

Parameters

ParameterType
nnumber

Returns

this

Inherited from

EventSubEventEmitter.setMaxListeners

Source

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


subscribe()

1
abstract subscribe<T>(options: SubscriptionOptions<T>): Promise<SubscriptionType<T, K>>

Subscribe to an EventSub event.

Type parameters

Type parameter
T extends SubscriptionTypes

Parameters

ParameterTypeDescription
optionsSubscriptionOptions<T>The options of the subscription.

Returns

Promise<SubscriptionType<T, K>>

Source

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


subscribeAll()

1
abstract subscribeAll<T>(...options: SubscriptionOptions<T>[]): Promise<SubscriptionType<T, K>[]>

Subscribe to multiple EventSub events.

Type parameters

Type parameter
T extends SubscriptionTypes

Parameters

ParameterTypeDescription
optionsSubscriptionOptions<T>[]The options of the subscriptions.

Returns

Promise<SubscriptionType<T, K>[]>

Source

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


waitForAllListenersToComplete()

1
waitForAllListenersToComplete(): Promise<boolean>

Returns

Promise<boolean>

Inherited from

EventSubEventEmitter.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 parameterValue
EventMap extends object-
EventName extends PropertyKeykeyof EventMap | keyof AsyncEventEmitterPredefinedEvents
Parameters
ParameterType
emitterAsyncEventEmitter<EventMap>
eventNameEventName | keyof AsyncEventEmitterPredefinedEvents
Returns

number

Inherited from

EventSubEventEmitter.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
ParameterType
emitterAsyncEventEmitter<any>
eventNamestring | symbol
Returns

number

Inherited from

EventSubEventEmitter.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 parameterValue
EventMap extends object-
EventName extends PropertyKeykeyof AsyncEventEmitterPredefinedEvents | keyof EventMap
Parameters
ParameterType
emitterAsyncEventEmitter<EventMap>
eventNameEventName
options?AbortableMethods
Returns

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

Inherited from

EventSubEventEmitter.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
ParameterType
emitterAsyncEventEmitter<any>
eventNamestring | symbol
options?AbortableMethods
Returns

AsyncGenerator<any[], void, unknown>

Inherited from

EventSubEventEmitter.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 parameterValue
EventMap extends object-
EventName extends PropertyKeykeyof AsyncEventEmitterPredefinedEvents | keyof EventMap
Parameters
ParameterType
emitterAsyncEventEmitter<EventMap>
eventNameEventName
options?AbortableMethods
Returns

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

Inherited from

EventSubEventEmitter.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
ParameterType
emitterAsyncEventEmitter<any>
eventNamestring | symbol
options?AbortableMethods
Returns

Promise<any[]>

Inherited from

EventSubEventEmitter.once

Source

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