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

HelixBitsLeaderboardEntry

A Bits leaderboard entry.

Overview

Properties

amount

Type: number

The amount of bits used in the given period of time.

rank

Type: number

The position of the user on the leaderboard.

userDisplayName

Type: string

The display name of the user on the leaderboard.

userId

Type: string

The ID of the user on the leaderboard.

userName

Type: string

The name of the user on the leaderboard.

Methods

getUser()

async

Retrieves the user of entry on the leaderboard.

Return type: HelixUser | null