TwurpleAuthenticationGetting dataExamplesFAQMigration

Main classes

HelixPredictor

A user that took part in a prediction.

Overview

Properties

channelPointsUsed

Type: number

The amount of channel points the predictor used for the prediction.

channelPointsWon

Type: number | null

The amount of channel points the predictor won for the prediction, or null if the prediction is not resolved yet, was cancelled or lost.

userDisplayName

Type: string

The display name of the predictor.

userId

Type: string

The user ID of the predictor.

userName

Type: string

The name of the predictor.

Methods

getUser()

async

Gets more information about the predictor.

Return type: HelixUser | null