Conduit

Represents a Conduit connection.

Extends

• BaseConnection<Conduit, ConduitEvents>

Constructors

new Conduit()

new Conduit(options: ConduitOptions): Conduit

Builds up a new Conduit.

Parameters

Parameter	Type	Description
options	ConduitOptions	The options of the conduit.

Returns

Conduit

Overrides

BaseConnection.constructor

Source

twitchfy/packages/eventsub/src/structures/Conduit.ts:62

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
conduitCleanup	readonly	boolean	Whether to cleanup the conduit shards at start avoiding duplicate shards. Default is true.	-
debug	public	boolean	Whether the connection is in debug mode or not.	BaseConnection.debug
deleteConduitOnNoShards	readonly	boolean	Whether to delete the conduit when you are going to delete the last shard of the conduit. Default is false.	-
dropSubsAtStart	readonly	boolean	Whether drop all subscriptions of the current conduit at start or not. Default is false.	-
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
shards	readonly	Map<string, Shard>	The shards of the conduit.	-
storage	readonly	StorageAdapter<Conduit>	The storage adapter used by the connection for storing subscriptions.	BaseConnection.storage
subscriptions	readonly	SubscriptionCollection<Conduit, SubscriptionTypes>	The subscriptions of the connection. You will only receive events for this subscriptions.	BaseConnection.subscriptions
workers	readonly	Map<string, Worker>	The workers of the conduit.	-

Accessors

appToken

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

The app token used to manage the conduit and its subscriptions.

Returns

TokenAdapter<"app", boolean>

Source

twitchfy/packages/eventsub/src/structures/Conduit.ts:86

---

id

get id(): string

The id of the conduit.

Returns

string

Source

twitchfy/packages/eventsub/src/structures/Conduit.ts:93

---

shardCount

get shardCount(): number

The number of shards of the conduit created by this process. This number is not synchronized with the API.

Returns

number

Source

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

Methods

addListener()

addListener(eventName, listener)

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

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof ConduitEvents

Parameters

Parameter	Type
eventName	K
listener	Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<ConduitEvents>, K, ConduitEvents>["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<ConduitEvents>, K, ConduitEvents>["listener"], undefined>): this

Type parameters

Type parameter
K extends string | symbol

Parameters

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

Returns

this

Inherited from

BaseConnection.addListener

Source

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

---

addShard()

addShard(shard: string): Promise<void>

Adds a shard to the conduit.

Parameters

Parameter	Type
shard	string

Returns

Promise<void>

Source

twitchfy/packages/eventsub/src/structures/Conduit.ts:339

---

deleteShard()

deleteShard(shardId: string): Promise<Shard[]>

Deletes a shard of a conduit. This operation is not recommended as it could result in an error unless all the shards of the conduit are being created within the same process.

Parameters

Parameter	Type
shardId	string

Returns

Promise<Shard[]>

Source

twitchfy/packages/eventsub/src/structures/Conduit.ts:270

---

emit()

emit(eventName, args)

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

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof ConduitEvents

Parameters

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

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<ConduitEvents>, K, ConduitEvents>): boolean

Type parameters

Type parameter
K extends string | symbol

Parameters

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

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 ConduitEvents[]

Returns

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

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 ConduitEvents

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<ConduitEvents>, K, ConduitEvents>["listener"], undefined>[]

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof ConduitEvents

Parameters

Parameter	Type
eventName	K

Returns

Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<ConduitEvents>, K, ConduitEvents>["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<ConduitEvents>, K, ConduitEvents>["listener"], undefined>[]

Type parameters

Type parameter
K extends string | symbol

Parameters

Parameter	Type
eventName	K

Returns

Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<ConduitEvents>, K, ConduitEvents>["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<ConduitEvents>, K, ConduitEvents>["listener"], undefined>): this

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof ConduitEvents

Parameters

Parameter	Type
eventName	K
listener	Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<ConduitEvents>, K, ConduitEvents>["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<ConduitEvents>, K, ConduitEvents>["listener"], undefined>): this

Type parameters

Type parameter
K extends string | symbol

Parameters

Parameter	Type
eventName	K
listener	Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<ConduitEvents>, K, ConduitEvents>["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<ConduitEvents>, K, ConduitEvents>["listener"], undefined>): this

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof ConduitEvents

Parameters

Parameter	Type
eventName	K
listener	Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<ConduitEvents>, K, ConduitEvents>["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<ConduitEvents>, K, ConduitEvents>["listener"], undefined>): this

Type parameters

Type parameter
K extends string | symbol

Parameters

Parameter	Type
eventName	K
listener	Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<ConduitEvents>, K, ConduitEvents>["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<ConduitEvents>, K, ConduitEvents>["listener"], undefined>): this

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof ConduitEvents

Parameters

Parameter	Type
eventName	K
listener	Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<ConduitEvents>, K, ConduitEvents>["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<ConduitEvents>, K, ConduitEvents>["listener"], undefined>): this

Type parameters

Type parameter
K extends string | symbol

Parameters

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

Returns

this

Inherited from

BaseConnection.once

Source

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

---

prependListener()

prependListener(eventName, listener)

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

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof ConduitEvents

Parameters

Parameter	Type
eventName	K
listener	Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<ConduitEvents>, K, ConduitEvents>["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<ConduitEvents>, K, ConduitEvents>["listener"], undefined>): this

Type parameters

Type parameter
K extends string | symbol

Parameters

Parameter	Type
eventName	K
listener	Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<ConduitEvents>, K, ConduitEvents>["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<ConduitEvents>, K, ConduitEvents>["listener"], undefined>): this

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof ConduitEvents

Parameters

Parameter	Type
eventName	K
listener	Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<ConduitEvents>, K, ConduitEvents>["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<ConduitEvents>, K, ConduitEvents>["listener"], undefined>): this

Type parameters

Type parameter
K extends string | symbol

Parameters

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

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof ConduitEvents

Parameters

Parameter	Type
eventName	K

Returns

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

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<ConduitEvents>, K, ConduitEvents>[]

Type parameters

Type parameter
K extends string | symbol

Parameters

Parameter	Type
eventName	K

Returns

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

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 ConduitEvents

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 ConduitEvents

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<ConduitEvents>, K, ConduitEvents>["listener"], undefined>): this

Type parameters

Type parameter
K extends keyof AsyncEventEmitterPredefinedEvents | keyof ConduitEvents

Parameters

Parameter	Type
eventName	K
listener	Exclude<InternalAsyncEventEmitterInternalListenerForEvent<AsyncEventEmitter<ConduitEvents>, K, ConduitEvents>["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<ConduitEvents>, K, ConduitEvents>["listener"], undefined>): this

Type parameters

Type parameter
K extends string | symbol

Parameters

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

Sets a new app token for the conduit.

Parameters

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

Returns

Conduit

The conduit.

Source

twitchfy/packages/eventsub/src/structures/Conduit.ts:358

---

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(): Promise<void>

Starts the conduit and all the shards in the Conduit’s options. The promise will resolve when all the shards are fully enabled within the API.

Returns

Promise<void>

Source

twitchfy/packages/eventsub/src/structures/Conduit.ts:108

---

subscribe()

subscribe<T>(options: SubscriptionOptions<T>): Promise<ConduitSubscription<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<ConduitSubscription<T>>

Overrides

BaseConnection.subscribe

Source

twitchfy/packages/eventsub/src/structures/Conduit.ts:112

---

subscribeAll()

subscribeAll<T>(...options: SubscriptionOptions<T>[]): Promise<ConduitSubscription<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<ConduitSubscription<T>[]>

Overrides

BaseConnection.subscribeAll

Source

twitchfy/packages/eventsub/src/structures/Conduit.ts:136

---

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