@varandas/clash-royale-api/lib/endpoints/tournaments.endpoint.d.ts

A Clash Royale API official wrapper for seamless integration with your applications.

import { AxiosInstance } from 'axios';
import { IGlobalTournaments, ITournament, ITournamentDetails, ITournamentRequestParams } from '../interfaces';
/**
 * Search all tournaments by name.
 *
 * It is not possible to specify ordering for results so clients
 * should not rely on any specific ordering as that may change in the future releases of the API.
 *
 * @param params
 * @param {AxiosInstance} apiClient
 */
declare const getTournaments: (params: ITournamentRequestParams, apiClient: AxiosInstance) => Promise<ITournament[]>;
/**
 * Get information about a single tournament by a tournament tag.
 *
 * @param {string} tag
 * @param {AxiosInstance} apiClient
 */
declare const getTournamentByTag: (tag: string, apiClient: AxiosInstance) => Promise<ITournamentDetails>;
/**
 * List all available global tournaments.
 *
 * @param {AxiosInstance} apiClient
 */
declare const getGlobalTournaments: (apiClient: AxiosInstance) => Promise<IGlobalTournaments[]>;
export { getTournaments, getTournamentByTag, getGlobalTournaments };