@kentcdodds/twitch

Monitor Twitch streams, send chat, and update channel settings.

src/smoke-test.ts

18 lines · 666 B · TypeScript

import { runSmokeTest } from './core.ts'
import type { TwitchSmokeTestResult } from './types.ts'

/**
 * Verify Twitch auth by reading the authenticated user and stream status.
 * Read-only: never sends chat or mutates channel settings.
 *
 * @returns ok flag plus login, displayName, and current stream snapshot.
 * @example
 * import smokeTest from 'kody:@kentcdodds/twitch/smoke-test'
 * const result = await smokeTest()
 * // => { ok: true, login: 'kentcdodds', displayName: 'Kent C. Dodds', stream: { isLive: false } }
 */
export default async function twitchSmokeTest(): Promise<TwitchSmokeTestResult> {
	return await runSmokeTest()
}

export { runSmokeTest }