LeagueEntry class
A representation of a summoner's competitive details.
Signature:
export declare class LeagueEntry Constructor
new LeagueEntry (client: Client, data: LeagueEntryData)Constructs a new instance of the LeagueEntry class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| client | Client | The client requesting the data. |
| data | LeagueEntryData | The raw league entry data from the API. |
Properties
division
The division under the tier - From 1 to 4 (I - IV).
Type: DivisionType
freshBlood
Whether the summoner is new to the game.
Type: Boolean
hotStreak
Whether the summoner is on a hot streak.
Type: Boolean
inactive
Whether the summoner has been inactive.
Type: Boolean
league
The league ID.
Type: String
losses
The number of losses the summoner has in this queue.
Type: Number
lp
The amount of league points (LP) the summoner has.
Type: Number
promos
This only exists if the summoner is in a promotion series.
Type: Promos
queueType
The type of queue - such as RANKED_SOLO_5x5, RANKED_FLEX_SR or RANKED_FLEX_TT.
Type: QueueType
summonerId
The ID of the summoner this data belongs to.
Type: String
summonerName
The name of the summoner this data belongs to.
Type: String
tier
The tier the summoner belongs to - such as BRONZE, GOLD, etc.
Type: TierType
veteran
Whether the summoner is a veteran or a pro player.
Type: Boolean
wins
The number of wins the summoner has in this queue.
Type: Number
Methods
.fetchSummoner ()
Fetch the summoner this data belongs to.
Signature:
fetchSummoner(options?: FetchOptions): Promise<Summoner>;Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | FetchOptions | The basic fetching options. |
Return type: Promise < Summoner >