@kentcdodds/twitch

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

src/update-channel-info.ts

19 lines · 816 B · TypeScript

import { updateChannelInfo } from './core.ts'
import type { TwitchUpdateChannelInfoParams, TwitchUpdateChannelInfoResult } from './types.ts'

/**
 * Update a Twitch channel title and/or game category during a broadcast.
 *
 * @returns Broadcaster login, updated fields, and HTTP status.
 * @example
 * import updateChannelInfo from 'kody:@kentcdodds/twitch/update-channel-info'
 * const result = await updateChannelInfo({ title: 'Building with Kody', gameName: 'Software and Game Development' })
 * // => { broadcasterLogin: 'kentcdodds', updated: { title: '...', game_id: '...' }, status: 204 }
 */
export default async function twitchUpdateChannelInfo(
	params: TwitchUpdateChannelInfoParams = {},
): Promise<TwitchUpdateChannelInfoResult> {
	return await updateChannelInfo(params)
}

export { updateChannelInfo }