Class Leaderboard

constructor

• new Leaderboard(client, data): Leaderboard

• Parameters

  • client: Client

    The main client.

  • data: {
        success: boolean;
        tts_leaderboard: {
            creator_user_token: string;
            default_avatar_color_index: number;
            default_avatar_index: number;
            display_name: string;
            gravatar_hash: string;
            uploaded_count: number;
            username: string;
        }[];
        w2l_leaderboard: {
            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 data from the FakeYou API.

    • success: boolean

    • tts_leaderboard: {
          creator_user_token: string;
          default_avatar_color_index: number;
          default_avatar_index: number;
          display_name: string;
          gravatar_hash: string;
          uploaded_count: number;
          username: string;
      }[]

    • w2l_leaderboard: {
          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 Leaderboard

Readonly ttsLeaderboard

Readonly w2lLeaderboard

Readonly webUrl

getEntry

• getEntry(index, type): undefined | LeaderboardUser

• Get an entry from the leaderboard using its index.

  Parameters

  • index: number

    the index of the entry. Starts at 0.

  • type: "tts" | "w2l"

    the type of the entry (tts or w2l).

  Returns undefined | LeaderboardUser

  the single entry.