@barbarbar338/bhapi
Version:
Brawlhalla API wrapper for NodeJS and web
72 lines • 2.9 kB
TypeScript
import { PlayerStats, SteamData } from "./types";
/**
* Get Steam data by profile URL
*
* @param {string} steamProfileURL Steam profile URL
* @returns {Promise<SteamData>} Promise resolving to the Steam data
*/
export declare const getSteamDataByURL: (steamProfileURL: string) => Promise<SteamData>;
/**
* Get Steam data by Steam ID
*
* @param {string} steamID Steam ID
* @returns {Promise<SteamData>} Promise resolving to the Steam data
*/
export declare const getSteamDataBySteamID: (steamID: string) => Promise<SteamData>;
/**
* Get Brawlhalla ID from Steam ID
*
* @param {string} steamID Steam ID
* @returns {Promise<number>} Promise resolving to the Brawlhalla ID
*/
export declare const getBHIDFromSteamID: (steamID: string) => Promise<number>;
/**
* Get Brawlhalla ID from Steam profile URL
*
* @param {string} steamProfileURL Steam profile URL
* @returns {Promise<number>} Promise resolving to the Brawlhalla ID
*/
export declare const getBHIDFromSteamURL: (steamProfileURL: string) => Promise<number>;
/**
* Get Brawlhalla stats by Steam ID
*
* @param {string} steamID Steam ID
* @returns {Promise<BrawlhallaStats>} Promise resolving to the Brawlhalla stats
*/
export declare const getStatsBySteamID: (steamID: string) => Promise<import("axios").AxiosResponse<PlayerStats, any, {}>>;
/**
* Get Brawlhalla stats by Steam profile URL
*
* @param {string} steamProfileURL Steam profile URL
* @returns {Promise<BrawlhallaStats>} Promise resolving to the Brawlhalla stats
*/
export declare const getStatsBySteamURL: (steamProfileURL: string) => Promise<import("axios").AxiosResponse<PlayerStats, any, {}>>;
/**
* Get Brawlhalla ranked data by Steam ID
*
* @param {string} steamID Steam ID
* @returns {Promise<BrawlhallaRankedData>} Promise resolving to the Brawlhalla ranked data
*/
export declare const getRankedBySteamID: (steamID: string) => Promise<import("axios").AxiosResponse<import("./types").PlayerRanked, any, {}>>;
/**
* Get Brawlhalla ranked data by Steam profile URL
*
* @param {string} steamProfileURL Steam profile URL
* @returns {Promise<BrawlhallaRankedData>} Promise resolving to the Brawlhalla ranked data
*/
export declare const getRankedBySteamURL: (steamProfileURL: string) => Promise<import("axios").AxiosResponse<import("./types").PlayerRanked, any, {}>>;
/**
* Get Brawlhalla glory by Steam ID
*
* @param {string} steamID Steam ID
* @returns {Promise<number>} Promise resolving to the Brawlhalla glory
*/
export declare const getGloryFromSteamID: (steamID: string) => Promise<import("./types").GloryData>;
/**
* Get Brawlhalla glory by Steam profile URL
*
* @param {string} steamProfileURL Steam profile URL
* @returns {Promise<number>} Promise resolving to the Brawlhalla glory
*/
export declare const getGloryFromSteamURL: (steamProfileURL: string) => Promise<import("./types").GloryData>;
//# sourceMappingURL=steam.d.ts.map