Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HelixTwitchUser

A single user object as from getTwitchUsersByID.

typedef

{Object} HelixTwitchUser

property

{string} id - The Twitch ID of the user. Universally unique.

property

{string} login - The user's login name

property

{string} description - The user's channel description

property

{string} display_name - A user formatted version of their username for display.

property

{string} profile_image_url - A URL to a Twitch-hosted version of this user's avatar.

property

{string} offline_image_url - A URL to a Twitch-hosted version of this user's offline background.

property

{string} type - The user's "type" on Twitch. One of ["staff", "admin", "global_mod", ""].

property

{string} broadcaster_type - The user's broadcaster type on Twitch. One of ["partner", "affiliate", ""].

property

{int} view_count - The user's total view count.

Hierarchy

  • HelixTwitchUser

Index

Properties

broadcaster_type

broadcaster_type: string

description

description: string

display_name

display_name: string

id

id: string

login

login: string

offline_image_url

offline_image_url: string

profile_image_url

profile_image_url: string

type

type: string

view_count

view_count: number

Generated using TypeDoc