@blizzard-api/sc2
Version:
A series of helpers to interact with the Starcraft II Blizzard API
39 lines (38 loc) • 1.49 kB
TypeScript
import { Resource, ResponseBase } from "@blizzard-api/core";
//#region src/league/types.d.ts
interface LeagueDataResponse extends ResponseBase {
key: Key;
tier: Array<Tier>;
}
type StarcraftLeagueId = 'bronze' | 'diamond' | 'gold' | 'grandmaster' | 'master' | 'platinum' | 'silver';
type StarcraftLeagueQueue = 'hots-1v1' | 'hots-2v2' | 'hots-3v3' | 'hots-4v4' | 'lotv-1v1' | 'lotv-2v2' | 'lotv-3v3' | 'lotv-4v4' | 'lotv-archon' | 'wol-1v1' | 'wol-2v2' | 'wol-3v3' | 'wol-4v4';
type StarcraftLeagueTeamType = 'arranged' | 'random';
interface Division {
id: number;
ladder_id: number;
member_count: number;
}
interface Key {
league_id: number;
queue_id: number;
season_id: number;
team_type: number;
}
interface Tier {
division: Array<Division>;
id: number;
}
//#endregion
//#region src/league/index.d.ts
/**
* Returns the league data for the specified season, queue, team type, and league.
* @param seasonId The season ID
* @param queueId The queue ID
* @param teamType The team type
* @param leagueId The league ID
* @returns The league data resource. See {@link LeagueDataResponse}.
*/
declare function getLeagueData(seasonId: string, queueId: StarcraftLeagueQueue, teamType: StarcraftLeagueTeamType, leagueId: StarcraftLeagueId): Resource<LeagueDataResponse>;
//#endregion
export { StarcraftLeagueTeamType as a, StarcraftLeagueQueue as i, LeagueDataResponse as n, StarcraftLeagueId as r, getLeagueData as t };
//# sourceMappingURL=index-D4dz9fHQ.d.ts.map