@kody/twitch

src/list-followers.ts

15 lines · 622 B · TypeScript
import { listFollowers } from './client.ts'

/**
 * Read followers of a Twitch channel (Helix GET /channels/followers).
 * Total is always returned. The follower list needs moderator:read:followers
 * and that the token user is the broadcaster or a moderator of that channel.
 *
 * @example
 * import listFollowers from 'kody:@kody/twitch/list-followers'
 * const result = await listFollowers({ limit: 20 })
 * // => { broadcasterLogin: '...', total: 100, followers: [...], listAvailable: true }
 */
export default async function twitchListFollowers(params: Record<string, unknown> = {}) {
	return listFollowers(params)
}