@blizzard-api/sc2/dist/index-DShZYxRE.d.ts

A series of helpers to interact with the Starcraft II Blizzard API

import { t as StarcraftRegion } from "./regions-C2THJaaU.js";
import { Resource } from "@blizzard-api/core";

//#region src/ladder/types.d.ts
interface GrandmasterLeaderboardResponse {
  ladderTeams: Array<LadderTeam>;
}
interface SeasonResponse {
  endDate: string;
  number: number;
  seasonId: number;
  startDate: string;
  year: number;
}
interface LadderTeam {
  joinTimestamp: number;
  losses: number;
  mmr: number;
  points: number;
  previousRank: number;
  teamMembers: Array<TeamMember>;
  wins: number;
}
interface TeamMember {
  clanTag?: string;
  displayName: string;
  favoriteRace: 'protoss' | 'random' | 'terran' | 'zerg';
  id: string;
  realm: number;
  region: number;
}
//#endregion
//#region src/ladder/index.d.ts
/**
 * Returns the grandmaster leaderboard for the specified region.
 * @param regionId The region ID
 * @returns The grandmaster leaderboard resource. See {@link GrandmasterLeaderboardResponse}.
 */
declare function grandmasterLeaderboard(regionId: StarcraftRegion): Resource<GrandmasterLeaderboardResponse>;
/**
 * Returns the season information for the specified region.
 * @param regionId The region ID
 * @returns The season resource. See {@link SeasonResponse}.
 */
declare function season(regionId: StarcraftRegion): Resource<SeasonResponse>;
//#endregion
export { SeasonResponse as i, season as n, GrandmasterLeaderboardResponse as r, grandmasterLeaderboard as t };
//# sourceMappingURL=index-DShZYxRE.d.ts.map