# LeaderBoard
Represents a FakeYou leaderboard
# Constructor
new LeaderBoard(client, data);
PARAMETER | TYPE | DESCRIPTION | OPTIONAL |
---|---|---|---|
client | Client | The client that instantiated this | No |
data | APIData | The leaderboard API data | No |
# Properties
# client
The client that instantiated this
- Type: Client
# group
The group of info this leaderboard has
- Type: Group <UserToken, LeaderBoardItem>
# Methods
# getPosition(position, isw2l)
Obtains an item based on its position in the leaderboard
PARAMETER | TYPE | DESCRIPTION | OPTIONAL |
---|---|---|---|
position | Number | The position to get | No |
isw2l | Boolean | If the item is from w2l leaderboard | Yes |
- Return: LeaderBoardItem
# tts()
Gets the TTS leaderboard
- Return: Group <UserToken, LeaderBoardItem>
# toArray()
Generates an array that contains username and count info
# w2l()
Gets the W2L leaderboard
- Return: Group <UserToken, LeaderBoardItem>