@kentcdodds/twitch

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

src/list-chatters.ts

19 lines · 726 B · TypeScript

import { listChatters } from './core.ts'
import type { TwitchListChattersParams, TwitchListChattersResult } from './types.ts'

/**
 * List chatters in a Twitch channel (requires moderator:read:chatters scope).
 *
 * @returns Chatters page with total count and pagination cursor.
 * @example
 * import listChatters from 'kody:@kentcdodds/twitch/list-chatters'
 * const result = await listChatters({ broadcasterLogin: 'kentcdodds', limit: 50 })
 * // => { broadcasterLogin: 'kentcdodds', total: 120, chatters: [...], cursor: '...' }
 */
export default async function twitchListChatters(
	params: TwitchListChattersParams = {},
): Promise<TwitchListChattersResult> {
	return await listChatters(params)
}

export { listChatters }