twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks

EventSubChannelCheerEvent

An EventSub event representing a user cheering bits.

Overview

Properties

bits

Type: number

The amount of bits cheered.

broadcasterDisplayName

Type: string

The display name of the broadcaster.

broadcasterId

Type: string

The ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

isAnonymous

Type: boolean

Whether the cheering user chose to be anonymous.

message

Type: string

The message sent with the cheer.

userDisplayName

Type: string | null

The display name of the cheering user, null if anonymous.

userId

Type: string | null

The ID of the cheering user, null if anonymous.

userName

Type: string | null

The name of the cheering user, null if anonymous.

Methods

getBroadcaster()

async

Retrieves more information about the broadcaster.

Return type: HelixUser

getUser()

async

Retrieves more information about the user.

Return type: HelixUser | null