Summoner class
A representation of a summoner (player).
Signature:
export declare class Summoner Constructor
new Summoner (client: Client, summoner: SummonerData, region?: Region)Constructs a new instance of the Summoner class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| client | Client | The client that requested this data. |
| summoner | SummonerData | The raw summoner data from the API. |
| region | Region | The region this summoner is located in. |
Properties
accountId
The account ID for this summoner.
Type: String
championMastery
A manager for the summoner's champion mastery.
Type: ChampionMasteryManager
id
The summoner ID for this summoner.
Type: String
level
The summoner level of this summoner.
Type: Number
name
The summoner name for this summoner.
Type: String
playerId
The unique player ID for this summoner. This is also called the PUUID.
Type: String
profileIcon
The current profile icon of this summoner.
Type: String
region
The region this summoner is located in.
Type: Region
revisionDate
The last time this summoner was modified.
Type: Date
Methods
.fetchAccount ()
Fetch the summoner's RIOT account info.
Signature:
fetchAccount(options?: FetchOptions): Promise<Account>;Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | FetchOptions | The basic fetching options. |
Return type: Promise < Account >
.fetchChallenges ()
Fetch the summoner's challenges progression.
Signature:
fetchChallenges(options?: FetchOptions): Promise<import("./SummonerChallenge").SummonerChallenge>;Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | FetchOptions | The basic fetching options. |
Return type: Promise < import("./SummonerChallenge").SummonerChallenge >
.fetchClashEntries ()
Fetch the summoner's clash entries.
Signature:
fetchClashEntries(options?: FetchOptions): Promise<import("./TournamentPlayer").TournamentPlayer[]>;Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | FetchOptions | The basic fetching options. |
Return type: Promise < import("./TournamentPlayer").TournamentPlayer >
.fetchLeagueEntries ()
Fetch the summoner's competitive placement info.
Signature:
fetchLeagueEntries(options?: FetchOptions): Promise<Collection<string, LeagueEntry>>;Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | FetchOptions | The basic fetching options. |
Return type: Promise < Collection < String, LeagueEntry > >
.fetchLiveMatch ()
Fetch the summoner's live game data.
Signature:
fetchLiveMatch(options?: FetchOptions): Promise<CurrentGame>;Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | FetchOptions | The basic fetching options. |
Return type: Promise < CurrentGame >
.fetchMatchList ()
Fetch the summoner's recent matches (always fetches from API).
Signature:
fetchMatchList(options?: MatchByPlayerOptions): Promise<string[]>;Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | MatchByPlayerOptions | The match list filtering options. |
Return type: Promise < String >