Class TwitchClient

Index

Methods

createSubscription deleteSubscription dispose getSessionId onNotification onSessionReset resolveUser sendChatMessage tokenFor forTest get

Methods

createSubscription

createSubscription(
    opts: {
        condition: Record<string, string>;
        token: string;
        type: string;
        version: string;
    },
): Promise<{ id: string }>
Create an EventSub websocket subscription of an arbitrary type (the no-chat-assumption seam). token is a user token bearing the required scope (the reader's user:read:chat for channel.chat.message).
Parameters
- opts: {
      condition: Record<string, string>;
      token: string;
      type: string;
      version: string;
  }
Returns Promise<{ id: string }>
- Defined in packages/server/src/backend/TwitchClient.ts:304

deleteSubscription

deleteSubscription(id: string, token: string): Promise<void>
Delete an EventSub subscription by id.
Parameters
- id: string
- token: string
Returns Promise<void>
- Defined in packages/server/src/backend/TwitchClient.ts:337

dispose

dispose(): void
Tear down the session (and its keepalive watchdog).

Returns void
- Defined in packages/server/src/backend/TwitchClient.ts:271

getSessionId

getSessionId(): Promise<string>
Open (lazily) the EventSub session and resolve its current id.

Returns Promise<string>
- Defined in packages/server/src/backend/TwitchClient.ts:287

onNotification

onNotification(handler: NotificationHandler): void
Register a notification handler (e.g. the relay reader's dispatch).
Parameters
- handler: NotificationHandler
Returns void
- Defined in packages/server/src/backend/TwitchClient.ts:277

onSessionReset

onSessionReset(handler: ResetHandler): void
Register a session-reset handler (re-create subscriptions).
Parameters
- handler: ResetHandler
Returns void
- Defined in packages/server/src/backend/TwitchClient.ts:282

resolveUser

resolveUser(
login: string,
token: string,
): Promise<{ id: string; login: string } | null>
Resolve a Twitch login to its stable broadcaster id (Helix /users). Used so a player can tune in by handle. Returns null for an unknown login (or a non-OK response).
Parameters
- login: string
- token: string
Returns Promise<{ id: string; login: string } | null>
- Defined in packages/server/src/backend/TwitchClient.ts:389

sendChatMessage

sendChatMessage(
    opts: {
        broadcasterId: string;
        senderId: string;
        text: string;
        token: string;
    },
): Promise<{ error?: string; messageId?: string; ok: boolean }>
Send a chat message to a broadcaster's channel as senderId, using senderId's user:write:chat token. Stateless — no socket.
Parameters
- opts: { broadcasterId: string; senderId: string; text: string; token: string }
Returns Promise<{ error?: string; messageId?: string; ok: boolean }>
- Defined in packages/server/src/backend/TwitchClient.ts:354

tokenFor

tokenFor(profile: TwitchProfile): Promise<string>
Resolve a usable access token for a profile, refreshing (and writing back) if it is at/near expiry. Callers always get a live token.
Parameters
- profile: TwitchProfile
Returns Promise<string>
- Defined in packages/server/src/backend/TwitchClient.ts:415

`Static`forTest

forTest(transport: TwitchTransport, reconnectDelayMs?: number): TwitchClient
Test-only factory: a fresh client over an injected transport with no reconnect delay. Not used in production (the singleton get() is).
Parameters
- transport: TwitchTransport
- reconnectDelayMs: number = 0
Returns TwitchClient
- Defined in packages/server/src/backend/TwitchClient.ts:263

`Static`get

get(): TwitchClient
Returns TwitchClient
- Defined in packages/server/src/backend/TwitchClient.ts:254