@varandas/clash-royale-api
Version:
A Clash Royale API official wrapper for seamless integration with your applications.
42 lines (41 loc) • 1.64 kB
TypeScript
import { AxiosInstance } from 'axios';
import { IClan, IClanWar, ILocation, ILocationFullRequestParams, ILocationRequestParams, IPlayer } from '../interfaces';
/**
* List all available locations.
*
* @param {ILocationRequestParams} params
* @param {AxiosInstance} apiClient
*/
declare const getLocations: (params: ILocationRequestParams, apiClient: AxiosInstance) => Promise<ILocation[]>;
/**
* Get information about specific location.
*
* @param {string} id
* @param {AxiosInstance} apiClient
*/
declare const getLocationById: (id: string, apiClient: AxiosInstance) => Promise<ILocation>;
/**
* Get clan rankings for a specific location.
*
* @param {string} id
* @param {ILocationFullRequestParams} params
* @param {AxiosInstance} apiClient
*/
declare const getClanRankingsForLocation: (id: string, params: ILocationFullRequestParams, apiClient: AxiosInstance) => Promise<IClan[]>;
/**
* Get player rankings for a specific location
*
* @param {string} id
* @param {ILocationFullRequestParams} params
* @param {AxiosInstance} apiClient
*/
declare const getPlayerRankingsForLocation: (id: string, params: ILocationFullRequestParams, apiClient: AxiosInstance) => Promise<IPlayer[]>;
/**
* Get clan rankings for a specific location
*
* @param {string} id
* @param { ILocationFullRequestParams } params
* @param { AxiosInstance } apiClient
*/
declare const getClanWarRankingsForLocation: (id: string, params: ILocationFullRequestParams, apiClient: AxiosInstance) => Promise<IClanWar[]>;
export { getLocations, getLocationById, getClanRankingsForLocation, getPlayerRankingsForLocation, getClanWarRankingsForLocation, };