WebSocketConnection

The WebSocket connection used for EventSub.

Extends

BaseConnection<WebSocketConnection, WebSocketEvents>

Constructors

new WebSocketConnection()

1
new WebSocketConnection(options: WebSocketConnectionOptions): WebSocketConnection

Builds up a new WebSocketConnection.

Parameters

Parameter	Type	Description
`options`	`WebSocketConnectionOptions`	The options for the connection.

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

1
get 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()

1
addListener<K>(eventName: K, listener: (...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : WebSocketEvents[K]) => void): this

Type parameters

Type parameter
`K` extends keyof AsyncEventEmitterPredefinedEvents \| keyof WebSocketEvents

Parameters

Parameter	Type
`eventName`	`K`
`listener`	(…`args`: `K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `WebSocketEvents`[`K`]) => `void`

Returns

this

Inherited from

BaseConnection.addListener

Source

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

connect()

1
connect(): Promise<void>

Connects to the WebSocket server.

Returns

Promise<void>

Source

twitchfy/packages/eventsub/src/ws/structures/WebSocketConnection.ts:54

emit()

1
emit<K>(eventName: K, ...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : WebSocketEvents[K]): boolean

Type parameters

Type parameter
`K` extends keyof AsyncEventEmitterPredefinedEvents \| keyof WebSocketEvents

Parameters

Parameter	Type
`eventName`	`K`
…`args`	`K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `WebSocketEvents`[`K`]

Returns

boolean

Inherited from

BaseConnection.emit

Source

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

eventNames()

1
eventNames(): (keyof AsyncEventEmitterPredefinedEvents | keyof WebSocketEvents)[]

Returns

(keyof AsyncEventEmitterPredefinedEvents | keyof WebSocketEvents)[]

Inherited from

BaseConnection.eventNames

Source

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

getMaxListeners()

1
getMaxListeners(): number

Returns

number

Inherited from

BaseConnection.getMaxListeners

Source

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

listenerCount()

1
listenerCount<K>(eventName: K): number

Type parameters

Type parameter
`K` extends keyof AsyncEventEmitterPredefinedEvents \| keyof WebSocketEvents

Parameters

Parameter	Type
`eventName`	`K`

Returns

number

Inherited from

BaseConnection.listenerCount

Source

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

listeners()

1
listeners<K>(eventName: K): (...args:
2
  | [WebSocketConnection]
3
  | [WebSocketConnection, string]
4
  | [WebSocketSubscription<SubscriptionTypes>]
5
  | [SubscriptionMessage<WebSocketConnection>, WebSocketSubscription<SubscriptionTypes>]
6
  | [WebSocketSubscription<SubscriptionTypes>]) => Awaitable<void>[]

Type parameters

Type parameter
`K` extends keyof AsyncEventEmitterPredefinedEvents \| keyof WebSocketEvents

Parameters

Parameter	Type
`eventName`	`K`

Returns

(…args: | [WebSocketConnection] | [WebSocketConnection, string] | [WebSocketSubscription<SubscriptionTypes>] | [SubscriptionMessage<WebSocketConnection>, WebSocketSubscription<SubscriptionTypes>] | [WebSocketSubscription<SubscriptionTypes>]) => Awaitable<void>[]

Inherited from

BaseConnection.listeners

Source

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

makeDebug()

1
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()

1
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()

1
off<K>(eventName: K, listener: (...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : WebSocketEvents[K]) => void): this

Type parameters

Type parameter
`K` extends keyof AsyncEventEmitterPredefinedEvents \| keyof WebSocketEvents

Parameters

Parameter	Type
`eventName`	`K`
`listener`	(…`args`: `K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `WebSocketEvents`[`K`]) => `void`

Returns

this

Inherited from

BaseConnection.off

Source

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

on()

1
on<K>(eventName: K, listener: (...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : WebSocketEvents[K]) => void): this

Type parameters

Type parameter
`K` extends keyof AsyncEventEmitterPredefinedEvents \| keyof WebSocketEvents

Parameters

Parameter	Type
`eventName`	`K`
`listener`	(…`args`: `K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `WebSocketEvents`[`K`]) => `void`

Returns

this

Inherited from

BaseConnection.on

Source

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

once()

1
once<K>(eventName: K, listener: (...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : WebSocketEvents[K]) => void): this

Type parameters

Type parameter
`K` extends keyof AsyncEventEmitterPredefinedEvents \| keyof WebSocketEvents

Parameters

Parameter	Type
`eventName`	`K`
`listener`	(…`args`: `K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `WebSocketEvents`[`K`]) => `void`

Returns

this

Inherited from

BaseConnection.once

Source

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

prependListener()

1
prependListener<K>(eventName: K, listener: (...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : WebSocketEvents[K]) => void): this

Type parameters

Type parameter
`K` extends keyof AsyncEventEmitterPredefinedEvents \| keyof WebSocketEvents

Parameters

Parameter	Type
`eventName`	`K`
`listener`	(…`args`: `K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `WebSocketEvents`[`K`]) => `void`

Returns

this

Inherited from

BaseConnection.prependListener

Source

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

prependOnceListener()

1
prependOnceListener<K>(eventName: K, listener: (...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : WebSocketEvents[K]) => void): this

Type parameters

Type parameter
`K` extends keyof AsyncEventEmitterPredefinedEvents \| keyof WebSocketEvents

Parameters

Parameter	Type
`eventName`	`K`
`listener`	(…`args`: `K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `WebSocketEvents`[`K`]) => `void`

Returns

this

Inherited from

BaseConnection.prependOnceListener

Source

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

rawListeners()

1
rawListeners<K>(eventName: K): Listener<
2
  | [WebSocketConnection]
3
  | [WebSocketConnection, string]
4
  | [WebSocketSubscription<SubscriptionTypes>]
5
  | [SubscriptionMessage<WebSocketConnection>, WebSocketSubscription<SubscriptionTypes>]
6
  | [WebSocketSubscription<SubscriptionTypes>]>[]

Type parameters

Type parameter
`K` extends keyof AsyncEventEmitterPredefinedEvents \| keyof WebSocketEvents

Parameters

Parameter	Type
`eventName`	`K`

Returns

Listener< | [WebSocketConnection] | [WebSocketConnection, string] | [WebSocketSubscription<SubscriptionTypes>] | [SubscriptionMessage<WebSocketConnection>, WebSocketSubscription<SubscriptionTypes>] | [WebSocketSubscription<SubscriptionTypes>]>[]

Inherited from

BaseConnection.rawListeners

Source

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

removeAllListeners()

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

Type parameters

Type parameter
`K` extends 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:12

removeListener()

1
removeListener<K>(eventName: K, listener: (...args: K extends keyof AsyncEventEmitterPredefinedEvents ? AsyncEventEmitterPredefinedEvents[K<K>] : WebSocketEvents[K]) => void): this

Type parameters

Type parameter
`K` extends keyof AsyncEventEmitterPredefinedEvents \| keyof WebSocketEvents

Parameters

Parameter	Type
`eventName`	`K`
`listener`	(…`args`: `K` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`K`<`K`>] : `WebSocketEvents`[`K`]) => `void`

Returns

this

Inherited from

BaseConnection.removeListener

Source

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

setAuth()

1
setAuth(userToken: TokenAdapter<"implicit" | "code", boolean>): WebSocketConnection

Sets the user token for the connection.

Parameters

Parameter	Type	Description
`userToken`	`TokenAdapter`<`"implicit"` \| `"code"`, `boolean`>	The new user token to set.

Returns

WebSocketConnection

The connection.

Source

twitchfy/packages/eventsub/src/ws/structures/WebSocketConnection.ts:113

setMaxListeners()

1
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:13

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

Overrides

BaseConnection.subscribe

Source

twitchfy/packages/eventsub/src/ws/structures/WebSocketConnection.ts:60

subscribeAll()

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

Overrides

BaseConnection.subscribeAll

Source

twitchfy/packages/eventsub/src/ws/structures/WebSocketConnection.ts:81

waitForAllListenersToComplete()

1
waitForAllListenersToComplete(): Promise<boolean>

Returns

Promise<boolean>

Inherited from

BaseConnection.waitForAllListenersToComplete

Source

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

listenerCount()

1
static listenerCount<Emitter, EventNames, EventName>(emitter: Emitter, eventName: keyof AsyncEventEmitterPredefinedEvents | EventName): number

Type parameters

Type parameter	Value
`Emitter` extends `AsyncEventEmitter`<`any`, `any`>	-
`EventNames`	`Emitter` extends `AsyncEventEmitter`<`Events`, `Events`> ? `Events` : `never`
`EventName` extends `PropertyKey`	`EventNames` extends `never` ? `string` \| `symbol` : keyof `EventNames`

Parameters

Parameter	Type
`emitter`	`Emitter`
`eventName`	keyof AsyncEventEmitterPredefinedEvents \| `EventName`

Returns

number

Inherited from

BaseConnection.listenerCount

Source

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

on()

1
static on<Emitter, EventNames, EventName, EventResult>(
2
   emitter: Emitter,
3
   eventName: EventName,
4
options?: AbortableMethods): AsyncGenerator<EventResult, void, unknown>

Type parameters

Type parameter	Value
`Emitter` extends `AsyncEventEmitter`<`any`, `any`>	-
`EventNames` extends `object`	`Emitter` extends `AsyncEventEmitter`<`Events`, `any`> ? `Events` : `Record`<`PropertyKey`, `unknown`[]>
`EventName` extends `PropertyKey`	keyof AsyncEventEmitterPredefinedEvents \| keyof `EventNames`
`EventResult` extends `unknown`[]	`EventNames` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`EventName`] : `EventNames`[`EventName`]

Parameters

Parameter	Type
`emitter`	`Emitter`
`eventName`	`EventName`
`options`?	`AbortableMethods`

Returns

AsyncGenerator<EventResult, void, unknown>

Inherited from

BaseConnection.on

Source

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

once()

1
static once<Emitter, EventNames, EventName, EventResult>(
2
   emitter: Emitter,
3
   eventName: EventName,
4
options?: AbortableMethods): Promise<EventResult>

Type parameters

Type parameter	Value
`Emitter` extends `AsyncEventEmitter`<`any`, `any`>	-
`EventNames` extends `object`	`Emitter` extends `AsyncEventEmitter`<`Events`, `any`> ? `Events` : `Record`<`PropertyKey`, `unknown`[]>
`EventName` extends `PropertyKey`	keyof AsyncEventEmitterPredefinedEvents \| keyof `EventNames`
`EventResult` extends `unknown`[]	`EventNames` extends keyof `AsyncEventEmitterPredefinedEvents` ? `AsyncEventEmitterPredefinedEvents`[`EventName`] : `EventNames`[`EventName`]

Parameters

Parameter	Type
`emitter`	`Emitter`
`eventName`	`EventName`
`options`?	`AbortableMethods`

Returns

Promise<EventResult>

Inherited from

BaseConnection.once

Source

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