Skip to main content

Teams

FunctionReturns
getTeamsForBroadcasterPromise<Array<Team>>
getTeamByIdPromise<TeamWithUsers | null>
getTeamByNamePromise<TeamWithUsers | null>

Functions​

getTeamsForBroadcaster​

twitch.team.getTeamsForBroadcaster(broadcasterId: UserIdResolvable): Promise<Array<Team>>

getTeamById​

twitch.team.getTeamById(teamId: string): Promise<TeamWithUsers | null>

getTeamByName​

twitch.team.getTeamByName(teamName: string): Promise<TeamWithUsers | null>

Types​

Team​

type Team = {
	id: string
	teamName: string
	teamDisplayName: string
	backgroundImageUrl: string | null
	banner: string | null
	createdAt: string
	updatedAt: string
	info: string
	thumbnailUrl: string
}

TeamWithUsers​

type TeamWithUsers = {
	users: Array<UserRelation>
	id: string
	teamName: string
	teamDisplayName: string
	backgroundImageUrl: string | null
	banner: string | null
	createdAt: string
	updatedAt: string
	info: string
	thumbnailUrl: string
}

UserIdResolvable​

type UserIdResolvable = string | UserIdResolvableType

UserIdResolvableType​

type UserIdResolvableType = {
	id: string
}

UserRelation​

type UserRelation = {
	userId: string
	userLogin: string
	userName: string
}