Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new default(api_key: string, path: string): default

Properties

dataPath

dataPath: string

key

key: string

region

region: string = "br1"

Methods

buildUrl

  • buildUrl(url: string, identifier: string, args: Object): string

  • Returns the URL with indentifiers, keys and search params`

    remarks

    This method is part of lol-api-js package as a utils function

    example

    const rawURL = "https://www.google.com/"; const identifier = "search"; const args = {q: "I love artifical intelligence"}; const url = buildUrl(rawURL, identifier, args) // url = "https://www.google.com/search?q=I+love+artificial+intelligence"

    Parameters

    • url: string

      string with the href

    • identifier: string

      string to join after the url with @var encodeURI

    • args: Object

      JSON Object with search parameters

    Returns string

    A @var string that represents a URL with keys and params

getChampionMastery

  • Sets the class properties @var championMastery as an Array<ChampionMastery>

    remarks

    This method is part of lol-api-js package and Summoner class

    Parameters

    • id: string

    Returns Promise<championMasteryData[]>

getLeagues

  • Sets the summoner class properties @var rankedFlex and @var rankedSolo

    remarks

    This method is part of lol-api-js package and API class

    Parameters

    • id: string

    Returns Promise<leagueData[]>

getMatchIds

  • getMatchIds(puuid: string, params?: Object): Promise<string[]>

  • Returns an Array of matchIds.

    remarks

    This method is part of lol-api-js package and API class

    Parameters

    • puuid: string
    • params: Object = {}

      optional pre-defined Object: params = {start: 0, count: 20};

    Returns Promise<string[]>

    An array of strings: Array<string>;

getSummoner

  • getSummoner(summonerName: string): Promise<default>

  • Method to retrieve a summoner object from RiotGames API

    remarks

    This method is part of lol-api-js package as a API class method

    example

    const api = new API('your Riot Api Key', 'your local datadragon path'); const summoner = api.getSummoner('summonerName');

    Parameters

    • summonerName: string

      a string containing the summoner name

    Returns Promise<default>

    A @var string that represents a URL with keys and params

Generated using TypeDoc