Methods
(static) checkMatchEligibility(matchDate, gameQueueID) → {boolean}
- Description:
- Checks a match for its date and queue ID
to determine if it should be processed or not
- Source:
Parameters:
| Name |
Type |
Description |
matchDate |
string
|
|
gameQueueID |
number
|
|
Returns:
-
Type
-
boolean
(static) findMoreMatches(region, puuid) → {Promise.<Array.<Object>, Object>}
- Description:
- Attempts to find more ranked/normal games to fill
the desired matchIDs length. If the length cannot be
filled it means no games can be found and it returns
- Source:
Parameters:
| Name |
Type |
Description |
region |
string
|
|
puuid |
string
|
|
Returns:
-
Type
-
Promise.<Array.<Object>, Object>
- Description:
- Formats timestamp milliseconds into DATETIME
format for entry in MySQL database
- Source:
Parameters:
| Name |
Type |
Description |
timestamp |
number
|
|
Returns:
-
Type
-
string
(static) getAllChampions() → {Map.<number, string>}
- Description:
- Method to retrieve JSON data of champions
to return mapping between their respective ids and names
- Source:
Returns:
-
Type
-
Map.<number, string>
(static) getChampionWinrate(masteryInfo, matchInfoList, rankedInfo)
- Description:
- Method that iterates through matches stored
and calculates champion winrate values
while ignoring remade games and non ranked games
- Source:
Parameters:
| Name |
Type |
Description |
masteryInfo |
Map
|
|
matchInfoList |
Array.<Array.<string>>
|
|
rankedInfo |
JSON
|
|
(static) getExtendedMatchList(region, puuid, lastGameDate) → {Array.<Object>|Promise.<Array.<Object>>}
- Description:
- Returns a matchList with matches from the last point extended in
the dashboard to extend the current list of games viewed. The matchList
is fetched through the DB if available or through an API call
- Source:
Parameters:
| Name |
Type |
Description |
region |
string
|
|
puuid |
string
|
|
lastGameDate |
string
|
|
Returns:
-
Type
-
Array.<Object>
|
Promise.<Array.<Object>>
- Description:
- Gathers input from field, retrieves data
from the DB or executes Riot API calls
to gather user account data for the input name
- Source:
Parameters:
| Name |
Type |
Description |
serverValue |
string
|
|
serverLabel |
string
|
|
regionValue |
string
|
|
navigate |
NavigateFunction
|
|
setIsLoading |
React.Dispatch.<React.SetStateAction.<boolean>>
|
|
setOpen |
React.Dispatch.<React.SetStateAction.<boolean>>
|
|
(static) getMasteryInfo(server, puuid) → {Object.<number, JSON>}
- Description:
- API call to retrieve arrays of summoner mastery info on all champions played
(champion ID, champion mastery level, champion mastery points)
based on puuid and server
- Source:
Parameters:
| Name |
Type |
Description |
server |
string
|
|
puuid |
string
|
|
Returns:
A mapping between champion ids and a JSON object
that holds champion data
-
Type
-
Object.<number, JSON>
(static) getMatchInfoList(matchIDs, region, puuid) → {Array.<Array.<string>>}
- Description:
- Retrieves and formats match information for every
matchID in the list through DB calls or API calls
depending on availability and returns an array of
arrays that contain the JSON objects with the information
about the match data, the summoner and all the participants
- Source:
Parameters:
| Name |
Type |
Description |
matchIDs |
Array.<string>
|
|
region |
string
|
|
puuid |
string
|
|
Returns:
-
Type
-
Array.<Array.<string>>
(static) getMatchList(region, puuid, matchAmountStart, matchAmount) → {Array.<Object>|Promise.<Array.<Object>>}
- Description:
- Retrieves an array of
summoner match IDs based on puuid
from the DB if its updated or through
API call
- Source:
Parameters:
| Name |
Type |
Description |
region |
string
|
|
puuid |
string
|
|
matchAmountStart |
number
|
|
matchAmount |
number
|
|
Returns:
-
Type
-
Array.<Object>
|
Promise.<Array.<Object>>
(static) getPUUID(tagLine, gameName) → {string}
- Description:
- API call to retrieve PUUID identifier
based on gameName and tagLine
- Source:
Parameters:
| Name |
Type |
Description |
tagLine |
string
|
|
gameName |
string
|
|
Returns:
-
Type
-
string
(static) getRankedInfo(server, puuid) → {JSON}
- Description:
- API call to retrieve summoner ranked queue info
(wins, losses, rank, tier)
based on id and server
- Source:
Parameters:
| Name |
Type |
Description |
server |
string
|
|
puuid |
string
|
|
Returns:
-
Type
-
JSON
(static) getRemakesNumber(rankedInfo, matchInfoList) → {number}
- Description:
- Scans through all matches to determine if
a games was under 5 minutes to be classified
as a remake
- Source:
Parameters:
| Name |
Type |
Description |
rankedInfo |
JSON
|
|
matchInfoList |
Array.<Array.<string>>
|
|
Returns:
-
Type
-
number
(static) getSummonerInfo(server, puuid) → {Array.<string>}
- Description:
- API call to retrieve summoner info (summoner id,summoner level, profile icon ID)
based on puuid and server
- Source:
Parameters:
| Name |
Type |
Description |
server |
string
|
|
puuid |
string
|
|
Returns:
-
Type
-
Array.<string>
(static) getSummonerStats(tagLine, gameName, server, region) → {JSON}
- Description:
- Driver method that retrieves all summoner data
based on database if no new information added
or by API calls to fill in missing data
- Source:
Parameters:
| Name |
Type |
Description |
tagLine |
string
|
|
gameName |
string
|
|
server |
string
|
|
region |
string
|
|
Returns:
-
Type
-
JSON
(static) getSummonerWinrates(rankedInfo, matchInfoList)
- Description:
- Calculates summoner winrate for ranked solo/duo and flex queue
modes based on ranked info and remade matches found
- Source:
Parameters:
| Name |
Type |
Description |
rankedInfo |
JSON
|
|
matchInfoList |
Array.<Array.<string>>
|
|
(static) loadVersion() → {Promise.<JSON>}
- Description:
- API call to Riot Data Dragon
for retrieving the latest patch version number
- Source:
Returns:
-
Type
-
Promise.<JSON>
(static) matchInfoAPICall(region, matchID) → {Promise.<JSON>}
- Description:
- API call to retrieve and format match
information data for a specific matchID
- Source:
Parameters:
| Name |
Type |
Description |
region |
string
|
|
matchID |
string
|
|
Returns:
-
Type
-
Promise.<JSON>
(static) matchInfoListDriver(region, matchIDs, puuid) → {Array.<Array.<string>>}
- Description:
- Driver method that etrieves all match
information from a matchID through
an API call or the DB it repeats
the process if no matches were found
- Source:
Parameters:
| Name |
Type |
Description |
region |
string
|
|
matchIDs |
Array.<string>
|
|
puuid |
string
|
|
Returns:
-
Type
-
Array.<Array.<string>>
(static) matchListUpdated(region, puuid) → {boolean}
- Description:
- Cross references the most recent match a summoner
played through an API call and checks if it is in
the database to determine if the list is updated
- Source:
Parameters:
| Name |
Type |
Description |
region |
string
|
|
puuid |
string
|
|
Returns:
-
Type
-
boolean