Class LeaderboardUser

A user in the leaderboard. The data here is limited compared to a profile user.

Implements

Constructors

constructor

Properties

client creatorUserToken defaultAvatarColorIndex defaultAvatarIndex displayName fetchProfile gravatarHash uploadedCount username webUrl

Constructors

constructor

  • new LeaderboardUser(client, data): LeaderboardUser

  • Parameters

    • client: Client

      The main client.

    • data: {
          creator_user_token: string;
          default_avatar_color_index: number;
          default_avatar_index: number;
          display_name: string;
          gravatar_hash: string;
          uploaded_count: number;
          username: string;
      }

      The raw leaderboard user data from the FakeYou API.

      • creator_user_token: string
      • default_avatar_color_index: number
      • default_avatar_index: number
      • display_name: string
      • gravatar_hash: string
      • uploaded_count: number
      • username: string

    Returns LeaderboardUser

Properties

Readonly client

client: Client

Readonly creatorUserToken

creatorUserToken: string

Readonly defaultAvatarColorIndex

defaultAvatarColorIndex: number

Readonly defaultAvatarIndex

defaultAvatarIndex: number

Readonly displayName

displayName: string

fetchProfile

fetchProfile: ((this) => Promise<ProfileUser | undefined>) = implFetchUser

Fetch the full user profile for this user, which includes more data than the leaderboard user.

Type declaration

    • (this): Promise<ProfileUser | undefined>

    • Fetch the full user profile for this user, which includes more data than the leaderboard user.

      Parameters

      Returns Promise<ProfileUser | undefined>

Readonly gravatarHash

gravatarHash: string

Readonly uploadedCount

uploadedCount: number

Readonly username

username: string

The username of the user.

Readonly webUrl

webUrl: string

The URL to the user's profile in the browser.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc