WebSocketConnection
The WebSocket connection used for EventSub.
Extends
Constructors
new WebSocketConnection()
1new WebSocketConnection(options: WebSocketConnectionOptions): WebSocketConnectionBuilds up a new WebSocketConnection.
Parameters
| Parameter | Type | Description | 
|---|---|---|
| options | WebSocketConnectionOptions | The options for the connection. | 
Returns
Overrides
Source
twitchfy/packages/eventsub/src/ws/structures/WebSocketConnection.ts:35
Properties
| Property | Modifier | Type | Description | Inherited from | 
|---|---|---|---|---|
| clientId | readonly | string | The client ID of the connection. | BaseConnection.clientId | 
| clientSecret | readonly | string | The client secret of the connection. | BaseConnection.clientSecret | 
| debug | public | boolean | Whether the connection is in debug mode or not. | BaseConnection.debug | 
| helixClient | readonly | HelixClient | The Helix client used by the connection for making API Requests. | BaseConnection.helixClient | 
| logger | readonly | Logger | The logger of the connection. | BaseConnection.logger | 
| maintainSubscriptions | readonly | boolean | Whether the connection should maintain the subscriptions or not between each start. | BaseConnection.maintainSubscriptions | 
| proxy? | readonly | string | The proxy url used for the connection. | - | 
| sessionId | public | string | The session id of the connection. | - | 
| storage | readonly | StorageAdapter<WebSocketConnection> | The storage adapter used by the connection for storing subscriptions. | BaseConnection.storage | 
| subscriptions | readonly | SubscriptionCollection<WebSocketConnection,SubscriptionTypes> | The subscriptions of the connection. You will only receive events for this subscriptions. | BaseConnection.subscriptions | 
| ws | public | WebSocket | The WebSocket client used for the connection. | - | 
Accessors
userToken
1get userToken(): UserTokenAdapter<boolean>Gets the user token that is being used for the connection.
Returns
UserTokenAdapter<boolean>
Source
twitchfy/packages/eventsub/src/ws/structures/WebSocketConnection.ts:123
Methods
addListener()
addListener(eventName, listener)
1addListener<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>): thisType parameters
| Type parameter | 
|---|
| Kextends keyof AsyncEventEmitterPredefinedEvents | keyof WebSocketEvents | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| listener | Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents>["listener"],undefined> | 
Returns
this
Inherited from
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:17
addListener(eventName, listener)
1addListener<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>): thisType parameters
| Type parameter | 
|---|
| Kextendsstring|symbol | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| listener | Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents>["listener"],undefined> | 
Returns
this
Inherited from
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:18
connect()
1connect(): Promise<void>Connects to the WebSocket server.
Returns
Promise<void>
Source
twitchfy/packages/eventsub/src/ws/structures/WebSocketConnection.ts:54
emit()
emit(eventName, args)
1emit<K>(eventName: K, ...args: InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<WebSocketEvents>, K, WebSocketEvents>): booleanType parameters
| Type parameter | 
|---|
| Kextends keyof AsyncEventEmitterPredefinedEvents | keyof WebSocketEvents | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| … args | InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents> | 
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<WebSocketEvents>, K, WebSocketEvents>): booleanType parameters
| Type parameter | 
|---|
| Kextendsstring|symbol | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| … args | InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents> | 
Returns
boolean
Inherited from
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:38
eventNames()
1eventNames(): (string | symbol)[] & keyof AsyncEventEmitterPredefinedEvents[] & keyof WebSocketEvents[]Returns
(string | symbol)[] & keyof AsyncEventEmitterPredefinedEvents[] & keyof WebSocketEvents[]
Inherited from
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:45
getMaxListeners()
1getMaxListeners(): numberReturns
number
Inherited from
BaseConnection.getMaxListeners
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:32
listenerCount()
listenerCount(eventName)
1listenerCount<K>(eventName: K): numberType parameters
| Type parameter | 
|---|
| Kextends keyof AsyncEventEmitterPredefinedEvents | keyof WebSocketEvents | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
Returns
number
Inherited from
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:39
listenerCount(eventName)
1listenerCount(eventName: string | symbol): numberParameters
| Parameter | Type | 
|---|---|
| eventName | string|symbol | 
Returns
number
Inherited from
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:40
listeners()
listeners(eventName)
1listeners<K>(eventName: K): Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>[]Type parameters
| Type parameter | 
|---|
| Kextends keyof AsyncEventEmitterPredefinedEvents | keyof WebSocketEvents | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
Returns
Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>[]
Inherited from
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:33
listeners(eventName)
1listeners<K>(eventName: K): Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>[]Type parameters
| Type parameter | 
|---|
| Kextendsstring|symbol | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
Returns
Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>[]
Inherited from
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:34
makeDebug()
1makeDebug(...args: any[]): voidMakes a debug log
Parameters
| Parameter | Type | Description | 
|---|---|---|
| … args | any[] | The arguments to log. | 
Returns
void
Inherited from
Source
twitchfy/packages/eventsub/src/structures/BaseConnection.ts:113
makeWarn()
1makeWarn(...args: any[]): voidMakes a warn log
Parameters
| Parameter | Type | Description | 
|---|---|---|
| … args | any[] | The arguments to log. | 
Returns
void
Inherited from
Source
twitchfy/packages/eventsub/src/structures/BaseConnection.ts:124
off()
off(eventName, listener)
1off<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>): thisType parameters
| Type parameter | 
|---|
| Kextends keyof AsyncEventEmitterPredefinedEvents | keyof WebSocketEvents | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| listener | Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents>["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<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>): thisType parameters
| Type parameter | 
|---|
| Kextendsstring|symbol | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| listener | Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents>["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<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>): thisType parameters
| Type parameter | 
|---|
| Kextends keyof AsyncEventEmitterPredefinedEvents | keyof WebSocketEvents | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| listener | Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents>["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<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>): thisType parameters
| Type parameter | 
|---|
| Kextendsstring|symbol | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| listener | Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents>["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<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>): thisType parameters
| Type parameter | 
|---|
| Kextends keyof AsyncEventEmitterPredefinedEvents | keyof WebSocketEvents | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| listener | Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents>["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<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>): thisType parameters
| Type parameter | 
|---|
| Kextendsstring|symbol | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| listener | Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents>["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<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>): thisType parameters
| Type parameter | 
|---|
| Kextends keyof AsyncEventEmitterPredefinedEvents | keyof WebSocketEvents | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| listener | Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents>["listener"],undefined> | 
Returns
this
Inherited from
BaseConnection.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<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>): thisType parameters
| Type parameter | 
|---|
| Kextendsstring|symbol | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| listener | Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents>["listener"],undefined> | 
Returns
this
Inherited from
BaseConnection.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<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>): thisType parameters
| Type parameter | 
|---|
| Kextends keyof AsyncEventEmitterPredefinedEvents | keyof WebSocketEvents | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| listener | Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents>["listener"],undefined> | 
Returns
this
Inherited from
BaseConnection.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<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>): thisType parameters
| Type parameter | 
|---|
| Kextendsstring|symbol | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| listener | Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents>["listener"],undefined> | 
Returns
this
Inherited from
BaseConnection.prependOnceListener
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:44
rawListeners()
rawListeners(eventName)
1rawListeners<K>(eventName: K): InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>, K, WebSocketEvents>[]Type parameters
| Type parameter | 
|---|
| Kextends keyof AsyncEventEmitterPredefinedEvents | keyof WebSocketEvents | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
Returns
InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>, K, WebSocketEvents>[]
Inherited from
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:35
rawListeners(eventName)
1rawListeners<K>(eventName: K): InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>, K, WebSocketEvents>[]Type parameters
| Type parameter | 
|---|
| Kextendsstring|symbol | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
Returns
InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>, K, WebSocketEvents>[]
Inherited from
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:36
removeAllListeners()
removeAllListeners(event)
1removeAllListeners<K>(event: K): thisType parameters
| Type parameter | 
|---|
| Kextends keyof AsyncEventEmitterPredefinedEvents | keyof WebSocketEvents | 
Parameters
| Parameter | Type | 
|---|---|
| event | K | 
Returns
this
Inherited from
BaseConnection.removeAllListeners
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:27
removeAllListeners(event)
1removeAllListeners<K>(event?: K): thisType parameters
| Type parameter | 
|---|
| Kextends keyof AsyncEventEmitterPredefinedEvents | keyof WebSocketEvents | 
Parameters
| Parameter | Type | 
|---|---|
| event? | K | 
Returns
this
Inherited from
BaseConnection.removeAllListeners
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:28
removeAllListeners(event)
1removeAllListeners(event: string | symbol): thisParameters
| Parameter | Type | 
|---|---|
| event | string|symbol | 
Returns
this
Inherited from
BaseConnection.removeAllListeners
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:29
removeAllListeners(event)
1removeAllListeners(event?: string | symbol): thisParameters
| Parameter | Type | 
|---|---|
| event? | string|symbol | 
Returns
this
Inherited from
BaseConnection.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<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>): thisType parameters
| Type parameter | 
|---|
| Kextends keyof AsyncEventEmitterPredefinedEvents | keyof WebSocketEvents | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| listener | Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents>["listener"],undefined> | 
Returns
this
Inherited from
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:23
removeListener(eventName, listener)
1removeListener<K>(eventName: K, listener: Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>, K, WebSocketEvents>["listener"], undefined>): thisType parameters
| Type parameter | 
|---|
| Kextendsstring|symbol | 
Parameters
| Parameter | Type | 
|---|---|
| eventName | K | 
| listener | Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebSocketEvents>,K,WebSocketEvents>["listener"],undefined> | 
Returns
this
Inherited from
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:24
setAuth()
1setAuth(userToken: TokenAdapter<"implicit" | "code", boolean>): WebSocketConnectionSets the user token for the connection.
Parameters
| Parameter | Type | Description | 
|---|---|---|
| userToken | TokenAdapter<"implicit"|"code",boolean> | The new user token to set. | 
Returns
The connection.
Source
twitchfy/packages/eventsub/src/ws/structures/WebSocketConnection.ts:113
setMaxListeners()
1setMaxListeners(n: number): thisParameters
| Parameter | Type | 
|---|---|
| n | number | 
Returns
this
Inherited from
BaseConnection.setMaxListeners
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:31
subscribe()
1subscribe<T>(options: SubscriptionOptions<T>): Promise<WebSocketSubscription<T>>Subscribe to an EventSub event.
Type parameters
| Type parameter | 
|---|
| TextendsSubscriptionTypes | 
Parameters
| Parameter | Type | Description | 
|---|---|---|
| options | SubscriptionOptions<T> | The options of the subscription. | 
Returns
Promise<WebSocketSubscription<T>>
Overrides
Source
twitchfy/packages/eventsub/src/ws/structures/WebSocketConnection.ts:60
subscribeAll()
1subscribeAll<T>(...options: SubscriptionOptions<T>[]): Promise<WebSocketSubscription<T>[]>Subscribe to multiple EventSub events.
Type parameters
| Type parameter | 
|---|
| TextendsSubscriptionTypes | 
Parameters
| Parameter | Type | Description | 
|---|---|---|
| … options | SubscriptionOptions<T>[] | The options of the subscriptions. | 
Returns
Promise<WebSocketSubscription<T>[]>
Overrides
Source
twitchfy/packages/eventsub/src/ws/structures/WebSocketConnection.ts:81
waitForAllListenersToComplete()
1waitForAllListenersToComplete(): Promise<boolean>Returns
Promise<boolean>
Inherited from
BaseConnection.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): numberType parameters
| Type parameter | Value | 
|---|---|
| EventMapextendsobject | - | 
| EventNameextendsPropertyKey | keyof EventMap| keyof AsyncEventEmitterPredefinedEvents | 
Parameters
| Parameter | Type | 
|---|---|
| emitter | AsyncEventEmitter<EventMap> | 
| eventName | EventName| keyof AsyncEventEmitterPredefinedEvents | 
Returns
number
Inherited from
Source
twitchfy/node_modules/@vladfrangu/async_event_emitter/dist/index.d.ts:49
listenerCount(emitter, eventName)
1static listenerCount(emitter: AsyncEventEmitter<any>, eventName: string | symbol): numberParameters
| Parameter | Type | 
|---|---|
| emitter | AsyncEventEmitter<any> | 
| eventName | string|symbol | 
Returns
number
Inherited from
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 | 
|---|---|
| EventMapextendsobject | - | 
| EventNameextendsPropertyKey | 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 | 
|---|---|
| EventMapextendsobject | - | 
| EventNameextendsPropertyKey | 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
