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()
1new BaseConnection<K, U>(options: BaseConnectionOptions<K>): BaseConnection<K, U>
Builds up a BaseConnection.
Parameters
Parameter | Type | Description |
---|---|---|
options | BaseConnectionOptions <K > | The options of the connection. |
Returns
BaseConnection
<K
, U
>
Overrides
EventSubEventEmitter
.constructor
Source
twitchfy/packages/eventsub/src/structures/BaseConnection.ts:74
Properties
Property | Modifier | Type | Description |
---|---|---|---|
clientId | readonly | string | The client ID of the connection. |
clientSecret | readonly | string | The client secret of the connection. |
debug | public | boolean | Whether the connection is in debug mode or not. |
helixClient | readonly | HelixClient | The Helix client used by the connection for making API Requests. |
logger | readonly | Logger | The logger of the connection. |
maintainSubscriptions | readonly | boolean | Whether the connection should maintain the subscriptions or not between each start. |
storage | readonly | StorageAdapter <K > | The storage adapter used by the connection for storing subscriptions. |
subscriptions | readonly | SubscriptionCollection <K , SubscriptionTypes > | The subscriptions of the connection. You will only receive events for this subscriptions. |
Methods
addListener()
addListener(eventName, listener)
1addListener<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
EventSubEventEmitter
.addListener
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:17
addListener(eventName, listener)
1addListener<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
EventSubEventEmitter
.addListener
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:18
emit()
emit(eventName, args)
1emit<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
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:37
emit(eventName, args)
1emit<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
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:38
eventNames()
1eventNames(): (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()
1getMaxListeners(): number
Returns
number
Inherited from
EventSubEventEmitter
.getMaxListeners
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:32
listenerCount()
listenerCount(eventName)
1listenerCount<K>(eventName: K): number
Type parameters
Type parameter |
---|
K extends string | number | symbol |
Parameters
Parameter | Type |
---|---|
eventName | K |
Returns
number
Inherited from
EventSubEventEmitter
.listenerCount
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:39
listenerCount(eventName)
1listenerCount(eventName: string | symbol): number
Parameters
Parameter | Type |
---|---|
eventName | string | symbol |
Returns
number
Inherited from
EventSubEventEmitter
.listenerCount
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:40
listeners()
listeners(eventName)
1listeners<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
EventSubEventEmitter
.listeners
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:33
listeners(eventName)
1listeners<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
EventSubEventEmitter
.listeners
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:34
makeDebug()
1makeDebug(...args: any[]): void
Makes a debug log
Parameters
Parameter | Type | Description |
---|---|---|
…args | any [] | The arguments to log. |
Returns
void
Source
twitchfy/packages/eventsub/src/structures/BaseConnection.ts:113
makeWarn()
1makeWarn(...args: any[]): void
Makes a warn log
Parameters
Parameter | Type | Description |
---|---|---|
…args | any [] | The arguments to log. |
Returns
void
Source
twitchfy/packages/eventsub/src/structures/BaseConnection.ts:124
off()
off(eventName, listener)
1off<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
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:25
off(eventName, listener)
1off<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
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:26
on()
on(eventName, listener)
1on<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
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:19
on(eventName, listener)
1on<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
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:20
once()
once(eventName, listener)
1once<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
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:21
once(eventName, listener)
1once<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
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:22
prependListener()
prependListener(eventName, listener)
1prependListener<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
EventSubEventEmitter
.prependListener
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:41
prependListener(eventName, listener)
1prependListener<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
EventSubEventEmitter
.prependListener
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:42
prependOnceListener()
prependOnceListener(eventName, listener)
1prependOnceListener<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
EventSubEventEmitter
.prependOnceListener
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:43
prependOnceListener(eventName, listener)
1prependOnceListener<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
EventSubEventEmitter
.prependOnceListener
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:44
rawListeners()
rawListeners(eventName)
1rawListeners<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
EventSubEventEmitter
.rawListeners
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:35
rawListeners(eventName)
1rawListeners<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
EventSubEventEmitter
.rawListeners
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:36
removeAllListeners()
removeAllListeners(event)
1removeAllListeners<K>(event: K): this
Type parameters
Type parameter |
---|
K extends string | number | symbol |
Parameters
Parameter | Type |
---|---|
event | K |
Returns
this
Inherited from
EventSubEventEmitter
.removeAllListeners
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:27
removeAllListeners(event)
1removeAllListeners<K>(event?: K): this
Type parameters
Type parameter |
---|
K extends string | number | symbol |
Parameters
Parameter | Type |
---|---|
event ? | K |
Returns
this
Inherited from
EventSubEventEmitter
.removeAllListeners
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:28
removeAllListeners(event)
1removeAllListeners(event: string | symbol): this
Parameters
Parameter | Type |
---|---|
event | string | symbol |
Returns
this
Inherited from
EventSubEventEmitter
.removeAllListeners
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:29
removeAllListeners(event)
1removeAllListeners(event?: string | symbol): this
Parameters
Parameter | Type |
---|---|
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)
1removeListener<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
EventSubEventEmitter
.removeListener
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:23
removeListener(eventName, listener)
1removeListener<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
EventSubEventEmitter
.removeListener
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:24
setMaxListeners()
1setMaxListeners(n: number): this
Parameters
Parameter | Type |
---|---|
n | number |
Returns
this
Inherited from
EventSubEventEmitter
.setMaxListeners
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:31
subscribe()
1abstract subscribe<T>(options: SubscriptionOptions<T>): Promise<SubscriptionType<T, K>>
Subscribe to an EventSub event.
Type parameters
Type parameter |
---|
T extends SubscriptionTypes |
Parameters
Parameter | Type | Description |
---|---|---|
options | SubscriptionOptions <T > | The options of the subscription. |
Returns
Promise
<SubscriptionType
<T
, K
>>
Source
twitchfy/packages/eventsub/src/structures/BaseConnection.ts:100
subscribeAll()
1abstract subscribeAll<T>(...options: SubscriptionOptions<T>[]): Promise<SubscriptionType<T, K>[]>
Subscribe to multiple EventSub events.
Type parameters
Type parameter |
---|
T extends SubscriptionTypes |
Parameters
Parameter | Type | Description |
---|---|---|
…options | SubscriptionOptions <T >[] | The options of the subscriptions. |
Returns
Promise
<SubscriptionType
<T
, K
>[]>
Source
twitchfy/packages/eventsub/src/structures/BaseConnection.ts:106
waitForAllListenersToComplete()
1waitForAllListenersToComplete(): 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)
1static 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
EventSubEventEmitter
.listenerCount
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:49
listenerCount(emitter, eventName)
1static listenerCount(emitter: AsyncEventEmitter<any>, eventName: string | symbol): number
Parameters
Parameter | Type |
---|---|
emitter | AsyncEventEmitter <any > |
eventName | string | 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)
1static on<EventMap, EventName>(2 emitter: AsyncEventEmitter<EventMap>,3 eventName: EventName,4options?: 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
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:53
on(emitter, eventName, options)
1static on(2 emitter: AsyncEventEmitter<any>,3 eventName: string | symbol,4options?: AbortableMethods): AsyncGenerator<any[], void, unknown>
Parameters
Parameter | Type |
---|---|
emitter | AsyncEventEmitter <any > |
eventName | string | symbol |
options ? | AbortableMethods |
Returns
AsyncGenerator
<any
[], void
, unknown
>
Inherited from
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:54
once()
once(emitter, eventName, options)
1static once<EventMap, EventName>(2 emitter: AsyncEventEmitter<EventMap>,3 eventName: EventName,4options?: 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
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:51
once(emitter, eventName, options)
1static once(2 emitter: AsyncEventEmitter<any>,3 eventName: string | symbol,4options?: AbortableMethods): Promise<any[]>
Parameters
Parameter | Type |
---|---|
emitter | AsyncEventEmitter <any > |
eventName | string | symbol |
options ? | AbortableMethods |
Returns
Promise
<any
[]>
Inherited from
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:52