Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Riot

Hierarchy

  • Riot

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • Default value RIOT_API_KEY: string = process.env.RIOT_API_KEY
    • Default value REGION_URL: RegionalUrls | string = RegionalUrls.AMERICAS
    • Default value PLATFORM_URL: PlatformUrls | string = PlatformUrls.NA1

    Returns Riot

Properties

PLATFORM_URL

PLATFORM_URL: PlatformUrls | string

REGION_URL

REGION_URL: RegionalUrls | string

Private RIOT_API_KEY

RIOT_API_KEY: string

Methods

getAPIKey

  • getAPIKey(): string

  • Returns string

getAllTftMatchesByPuuid

  • getAllTftMatchesByPuuid(encryptedPUUID?: string): Promise<Array<number>>

getTftAdvLeague

  • ** LEAGUE *****

    Parameters

    • Default value leagueName: AdvLeague | string = AdvLeague.challenger

    Returns Promise<LeagueListDTO>

getTftByMatchId

  • getTftByMatchId(matchId?: string): Promise<TFTMatch>

getTftEntriesByTier

  • Parameters

    • Default value tier: Tier | string = Tier.DIAMOND
    • Default value division: Division | string = Division.I

    Returns Promise<LeagueEntryDTO>

getTftLeagueById

  • Parameters

    • leagueId: string

    Returns Promise<LeagueListDTO>

getTftMatches

  • getTftMatches(encryptedSummonerId: string): Promise<LeagueListDTO>

  • Parameters

    • encryptedSummonerId: string

    Returns Promise<LeagueListDTO>

getTftSummonerByAccount

  • getTftSummonerByAccount(accountId?: string): Promise<SummonerObj>

getTftSummonerById

  • getTftSummonerById(id?: string): Promise<SummonerObj>

getTftSummonerByName

  • getTftSummonerByName(summonerName?: string): Promise<SummonerObj>

getTftSummonerByPuuid

  • getTftSummonerByPuuid(puuId?: string): Promise<SummonerObj>

  • Parameters

    • Default value puuId: string = "wNAH--jmUok3Ln2Gbt0VHl_qfJhk8OJEFmC5o_fWyr3eD4D1e34x2WIfeGY8i_7kfmZ9fPrQtH-hCg"

    Returns Promise<SummonerObj>

Private makeFetchOptions

  • makeFetchOptions(method?: HTTP, AcceptLanguage?: string, AcceptCharSet?: string): object | object

  • Parameters

    • Default value method: HTTP = HTTP.GET
    • Default value AcceptLanguage: string = "en-US,en;q=0.9"
    • Default value AcceptCharSet: string = "application/x-www-form-urlencoded; charset=UTF-8"

    Returns object | object

setAPIKey

  • setAPIKey(NEW_API_KEY: string): void

  • Parameters

    • NEW_API_KEY: string

    Returns void

Generated using TypeDoc