Class UserStructure

constructor

• new UserStructure(client: Client, data: any): UserStructure

  Parameters

  • client: Client
  • data: any

  Returns UserStructure

broadcaster

channel

color

displayName

mod

subscriber

turbo

vip

ban

• ban(reason?: string): Promise<void>

  Ban user on a channel

  Parameters

  • reason: string = ''

    The reason for the ban

  Returns Promise<void>

timeout

• timeout(Params: { reason: string; seconds?: number }): Promise<void>

  Timeout user on a channel

  Parameters

  • Params: { reason: string; seconds?: number }

    the timeout params

    • reason: string

      The reason why this user got a timeout

    • Optionalseconds?: number

      The time in seconds to timeout this user

  Returns Promise<void>

unban

• unban(): Promise<void>

  Remove ban from user

  Returns Promise<void>

untimeout

• untimeout(): Promise<void>

  Remove timeout from user

  Returns Promise<void>