Class TwitchRelayReader

Index

Methods

boot isConfigured resolveLogin send subscribe unsubscribe get

Methods

boot

boot(): void
Wire the client + logout listeners. Idempotent.

Returns void
- Defined in packages/server/src/backend/TwitchRelayReader.ts:51

isConfigured

isConfigured(): boolean
Whether a reader account is configured (TWITCH_READER_USER_ID).

Returns boolean
- Defined in packages/server/src/backend/TwitchRelayReader.ts:88

resolveLogin

resolveLogin(
login: string,
): Promise<{ broadcasterId: string; login: string } | null>
Helix login → broadcaster id (the tune-by-handle lookup).
Parameters
- login: string
Returns Promise<{ broadcasterId: string; login: string } | null>
- Defined in packages/server/src/backend/TwitchRelayReader.ts:93

send

send(
opts: { broadcasterId: string; profile: TwitchProfile; text: string },
): Promise<{ error?: string; ok: boolean }>
Stateless Helix Send Chat Message as the poster.
Parameters
- opts: { broadcasterId: string; profile: TwitchProfile; text: string }
Returns Promise<{ error?: string; ok: boolean }>
- Defined in packages/server/src/backend/TwitchRelayReader.ts:103

subscribe(broadcasterId: string): void
Subscribe to a channel's chat (debounced). Driven by the 0->1 edge.
Parameters
- broadcasterId: string
Returns void
- Defined in packages/server/src/backend/TwitchRelayReader.ts:122

unsubscribe

unsubscribe(broadcasterId: string): void
Unsubscribe from a channel's chat (debounced). Driven by the 1->0 edge.
Parameters
- broadcasterId: string
Returns void
- Defined in packages/server/src/backend/TwitchRelayReader.ts:127

`Static`get

get(): TwitchRelayReader
Returns TwitchRelayReader
- Defined in packages/server/src/backend/TwitchRelayReader.ts:45