lol-api-js/lib/summoner.d.ts

Integration package LoL Riot API and your typescript/javascript

import API from ".";
import ChampionMastery, { championMasteryData } from "./championMastery";
import League, { leagueData } from "./league";
import Match from "./match";
declare class Summoner extends API {
    id: string;
    accountId: string;
    profileIconId: number;
    revisionDate: number;
    name: string;
    puuid: string;
    summonerLevel: number;
    championMasteryArray: ChampionMastery[];
    rankedSolo: League;
    rankedFlex: League;
    matchIds: string[];
    constructor(api_key: string, path: string, jsonObj: summonerData, leagueArr: leagueData[], champMastObj: championMasteryData[], matchIds: string[]);
    /**
     * Returns the path to the icon location`
     *
     * @returns A @var string that represents a path to an `.png`
     *
     * @remarks
     * This method is part of lol-api-js package and Summoner class
     *
     * @example
     * summoner = new Summoner();
     * summoner.get(summonerName);
     * summoner.getProfileIcon();
     */
    getProfileIcon: () => string;
    /**
     * Returns a Match object with match details for a given matchId.
     *
     * @remarks
     * This method is part of lol-api-js package from the Match class
     *
     * @param matchId - matchId that can be acessed through:
     *
     * ```
     * summoner = new Summoner();
     * summoner.get(summonerName);
     * arrayOfMatchIds = summoner.getMatchIds();
     * ```
     *
     * @example
     * match = new Match();
     * match.getMatch(matchId);
     */
    getMatch: (matchId: string) => Promise<Match>;
    /**
     * Returns an Array of Summoners object with summoners details.
     *
     * @remarks
     * This method is part of lol-api-js package from the Match class
     *
     * @async
     * @param participants
     * array of strings (Participant interface)
     *
     * @returns
     * Returns an array of Summoners object.
     *
     * @private
     * This is a private method, it cannot be called outside of its class
     *
     */
    private getInvolvedSummoners;
}
export default Summoner;
export interface summonerData {
    id: string;
    accountId: string;
    profileIconId: number;
    revisionDate: number;
    name: string;
    puuid: string;
    summonerLevel: number;
}
//# sourceMappingURL=summoner.d.ts.map