splatoon3api/dist/main.d.ts

A simple Method to get current and next Splatoon 3 maps, Salmonrun Schedules and Splatnet gear

import * as Types from './types';
declare class Client {
    lang: Types.Lang;
    options: Types.Options;
    private langPromise;
    private translation;
    /**
     * @param {Types.Lang} [lang="en-US"] - The language for map names, challenge descriptions etc.
     * @param {Types.Options} [options] - The options for the client
     */
    constructor(lang?: Types.Lang, options?: Types.Options | undefined);
    /**
     * Get 11 upcoming and the current Turf War, Ranked and XBattle maps
     * @returns {Promise<Types.AllStagesResponse>} - The promise
     */
    getStages(): Promise<Types.AllStagesResponse>;
    /**
     * Get the current Turf War, Ranked and XBattle maps
     * @returns {Promise<Types.StagesResponse>} - The promise
     */
    getCurrentStages(): Promise<Types.StagesResponse>;
    /**
     * Get the upcoming Turf War, Ranked and XBattle maps
     * @returns {Promise<Types.StagesResponse>} - The promise
     */
    getNextStages(): Promise<Types.StagesResponse>;
    /**
     * Get the current challenges
     * @returns {Promise<Types.SplatChallenge[]>} - The promise
     */
    getChallenges(): Promise<Types.SplatChallenge[]>;
    /**
     * To get the current and next Salmonruns Schedules
     * @returns {Promise<import('./types').SalmonResult>} - The promise
     */
    getSalmonRun(): Promise<Types.SalmonResult>;
    /**
     * Get the current gear that is available in the splatnet shop
     * @returns {Promise<import('./types').SplatnetResult>} - The promise
     */
    getSplatnetGear(): Promise<Types.SplatnetResult>;
    /**
     * Get already scheduled Splatfests
     * @returns {Promise<import('./types').FestData>} - The promise
     */
    getUpcomingSplatfests(): Promise<Types.FestData>;
    /**
     * Get past Splatfests
     * @returns {Promise<import('./types').PastFestData>} - The promise
     */
    getPastSplatfests(): Promise<Types.PastFestData>;
    /**
     * Get the currently running Splatfests
     * @returns {Promise<import('./types').FestData>} - The promise
     */
    getRunningSplatfests(): Promise<Types.RunningFestData>;
}
export { Client, Types };