WebhookConnection

A Webhook Connection.

Extends

• BaseConnection<WebhookConnection, WebhookEvents>

Constructors

new WebhookConnection()

new WebhookConnection(options: WebhookConnectionOptions, server?: Express): WebhookConnection

Builds up a new WebhookConnection.

Parameters

Parameter	Type	Description
options	WebhookConnectionOptions	The options for the connection.
server?	Express	The express server used for receiving Twitch data.

Returns

WebhookConnection

Overrides

BaseConnection.constructor

Source

twitchfy/packages/eventsub/src/webhook/structures/WebhookConnection.ts:62

Properties

Property	Modifier	Type	Description	Inherited from
baseURL	readonly	string	The base URL for the webhook callback.	-
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
dropSubsAtStart	readonly	boolean	Whether to drop subscriptions at start. This will delete all subscriptions that are currently active within the client (only webhook created) to avoid duplicated subscriptions if any storage was set.	-
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
secret	readonly	string	The secret used for creating subscriptions within this connection.	-
server	readonly	Express	The express server used for receiving Twitch data.	-
startServer	readonly	boolean	Whether to start the server when the connection is started.	-
storage	readonly	StorageAdapter<WebhookConnection>	The storage adapter used by the connection for storing subscriptions.	BaseConnection.storage
subscriptionRoute	readonly	string	The route for receiving Twitch messages. Default /subscriptions	-
subscriptions	readonly	SubscriptionCollection<WebhookConnection, SubscriptionTypes>	The subscriptions of the connection. You will only receive events for this subscriptions.	BaseConnection.subscriptions

Accessors

appToken

get appToken(): TokenAdapter<"app", boolean>

The app token used for the connection.

Returns

TokenAdapter<"app", boolean>

Source

twitchfy/packages/eventsub/src/webhook/structures/WebhookConnection.ts:168

---

url

get url(): string

The URL for the webhook callback. This is a join between the base url and the subscription route.

Returns

string

Source

twitchfy/packages/eventsub/src/webhook/structures/WebhookConnection.ts:86

Methods

addListener()

addListener(eventName, listener)

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

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof WebhookEvents

Parameters

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

Returns

this

Inherited from

BaseConnection.addListener

Source

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

addListener(eventName, listener)

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

Type parameters

Type parameter
K extends string | symbol

Parameters

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

Returns

this

Inherited from

BaseConnection.addListener

Source

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

---

emit()

emit(eventName, args)

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

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof WebhookEvents

Parameters

Parameter	Type
eventName	K
…args	InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<WebhookEvents>, K, WebhookEvents>

Returns

boolean

Inherited from

BaseConnection.emit

Source

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

emit(eventName, args)

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

Type parameters

Type parameter
K extends string | symbol

Parameters

Parameter	Type
eventName	K
…args	InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<WebhookEvents>, K, WebhookEvents>

Returns

boolean

Inherited from

BaseConnection.emit

Source

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

---

eventNames()

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

Returns

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

Inherited from

BaseConnection.eventNames

Source

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

---

getMaxListeners()

getMaxListeners(): number

Returns

number

Inherited from

BaseConnection.getMaxListeners

Source

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

---

listenerCount()

listenerCount(eventName)

listenerCount<K>(eventName: K): number

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof WebhookEvents

Parameters

Parameter	Type
eventName	K

Returns

number

Inherited from

BaseConnection.listenerCount

Source

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

listenerCount(eventName)

listenerCount(eventName: string | symbol): number

Parameters

Parameter	Type
eventName	string | symbol

Returns

number

Inherited from

BaseConnection.listenerCount

Source

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

---

listeners()

listeners(eventName)

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

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof WebhookEvents

Parameters

Parameter	Type
eventName	K

Returns

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

Inherited from

BaseConnection.listeners

Source

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

listeners(eventName)

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

Type parameters

Type parameter
K extends string | symbol

Parameters

Parameter	Type
eventName	K

Returns

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

Inherited from

BaseConnection.listeners

Source

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

---

makeDebug()

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

Makes a debug log

Parameters

Parameter	Type	Description
…args	any[]	The arguments to log.

Returns

void

Inherited from

BaseConnection.makeDebug

Source

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

---

makeWarn()

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

Makes a warn log

Parameters

Parameter	Type	Description
…args	any[]	The arguments to log.

Returns

void

Inherited from

BaseConnection.makeWarn

Source

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

---

off()

off(eventName, listener)

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

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof WebhookEvents

Parameters

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

Returns

this

Inherited from

BaseConnection.off

Source

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

off(eventName, listener)

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

Type parameters

Type parameter
K extends string | symbol

Parameters

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

Returns

this

Inherited from

BaseConnection.off

Source

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

---

on()

on(eventName, listener)

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

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof WebhookEvents

Parameters

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

Returns

this

Inherited from

BaseConnection.on

Source

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

on(eventName, listener)

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

Type parameters

Type parameter
K extends string | symbol

Parameters

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

Returns

this

Inherited from

BaseConnection.on

Source

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

---

once()

once(eventName, listener)

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

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof WebhookEvents

Parameters

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

Returns

this

Inherited from

BaseConnection.once

Source

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

once(eventName, listener)

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

Type parameters

Type parameter
K extends string | symbol

Parameters

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

Returns

this

Inherited from

BaseConnection.once

Source

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

---

post()

post(
   headers: IncomingHttpHeaders,
   body: any,
   verification: (challenge: string) => any,
   success: () => any,
invalidSignature?: () => any): Promise<any>

Used for handling incoming Twitch requests in your custom non-Express server.

Parameters

Parameter	Type	Description
headers	IncomingHttpHeaders	The headers of the request.
body	any	The body of the request.
verification	(challenge: string) => any	A callback to be called when the request is a webhook callback verification and you need to send the challenge.
success	() => any	A callback to be called when the handling has suceeded. You will need to send a 200 status in the response after that.
invalidSignature?	() => any	A callback which is executed when the signature that has been sent by the requester is incorrect.

Returns

Promise<any>

Source

twitchfy/packages/eventsub/src/webhook/structures/WebhookConnection.ts:181

---

prependListener()

prependListener(eventName, listener)

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

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof WebhookEvents

Parameters

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

Returns

this

Inherited from

BaseConnection.prependListener

Source

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

prependListener(eventName, listener)

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

Type parameters

Type parameter
K extends string | symbol

Parameters

Parameter	Type
eventName	K
listener	Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<WebhookEvents>, K, WebhookEvents>["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)

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

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof WebhookEvents

Parameters

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

Returns

this

Inherited from

BaseConnection.prependOnceListener

Source

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

prependOnceListener(eventName, listener)

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

Type parameters

Type parameter
K extends string | symbol

Parameters

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

Returns

this

Inherited from

BaseConnection.prependOnceListener

Source

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

---

rawListeners()

rawListeners(eventName)

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

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof WebhookEvents

Parameters

Parameter	Type
eventName	K

Returns

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

Inherited from

BaseConnection.rawListeners

Source

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

rawListeners(eventName)

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

Type parameters

Type parameter
K extends string | symbol

Parameters

Parameter	Type
eventName	K

Returns

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

Inherited from

BaseConnection.rawListeners

Source

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

---

removeAllListeners()

removeAllListeners(event)

removeAllListeners<K>(event: K): this

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof WebhookEvents

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)

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

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof WebhookEvents

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)

removeAllListeners(event: string | symbol): this

Parameters

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)

removeAllListeners(event?: string | symbol): this

Parameters

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)

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

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof WebhookEvents

Parameters

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

Returns

this

Inherited from

BaseConnection.removeListener

Source

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

removeListener(eventName, listener)

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

Type parameters

Type parameter
K extends string | symbol

Parameters

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

Returns

this

Inherited from

BaseConnection.removeListener

Source

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

---

setAuth()

setAuth(appToken: TokenAdapter<"app", boolean>): WebhookConnection

Sets a new app token for the connection.

Parameters

Parameter	Type	Description
appToken	TokenAdapter<"app", boolean>	The new app token.

Returns

WebhookConnection

The connection.

Source

twitchfy/packages/eventsub/src/webhook/structures/WebhookConnection.ts:158

---

setMaxListeners()

setMaxListeners(n: number): this

Parameters

Parameter	Type
n	number

Returns

this

Inherited from

BaseConnection.setMaxListeners

Source

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

---

start()

start(port?: number, callback?: () => void): Promise<boolean>

Starts the Webhook Connection.

Parameters

Parameter	Type	Description
port?	number	The port to start the server at if the startServer option is set to true.
callback?	() => void	A callback to be called when the server is started if the startServer option is set to true.

Returns

Promise<boolean>

Source

twitchfy/packages/eventsub/src/webhook/structures/WebhookConnection.ts:143

---

subscribe()

subscribe<T>(options: SubscriptionOptions<T>): Promise<WebhookSubscription<T>>

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<WebhookSubscription<T>>

Overrides

BaseConnection.subscribe

Source

twitchfy/packages/eventsub/src/webhook/structures/WebhookConnection.ts:90

---

subscribeAll()

subscribeAll<T>(...options: SubscriptionOptions<T>[]): Promise<WebhookSubscription<T>[]>

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<WebhookSubscription<T>[]>

Overrides

BaseConnection.subscribeAll

Source

twitchfy/packages/eventsub/src/webhook/structures/WebhookConnection.ts:111

---

waitForAllListenersToComplete()

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

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

BaseConnection.listenerCount

Source

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

listenerCount(emitter, eventName)

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

Parameters

Parameter	Type
emitter	AsyncEventEmitter<any>
eventName	string | symbol

Returns

number

Inherited from

BaseConnection.listenerCount

Source

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

---

on()

on(emitter, eventName, options)

static on<EventMap, EventName>(
   emitter: AsyncEventEmitter<EventMap>,
   eventName: EventName,
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

BaseConnection.on

Source

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

on(emitter, eventName, options)

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

Parameters

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

Returns

AsyncGenerator<any[], void, unknown>

Inherited from

BaseConnection.on

Source

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

---

once()

once(emitter, eventName, options)

static once<EventMap, EventName>(
   emitter: AsyncEventEmitter<EventMap>,
   eventName: EventName,
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

BaseConnection.once

Source

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

once(emitter, eventName, options)

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

Parameters

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

Returns

Promise<any[]>

Inherited from

BaseConnection.once

Source

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