@blizzard-api/wow
Version:
A series of helpers to interact with the World of Warcraft Blizzard API
61 lines (60 loc) • 1.7 kB
JavaScript
import { wowBasePath } from "@blizzard-api/core";
//#region src/pvp-season/index.ts
/**
* Get a PvP leaderboard by PvP season ID and bracket.
* @param pvpSeasonId The PvP season ID.
* @param bracket The PvP bracket.
* @returns The PvP leaderboard. See {@link PvpLeaderboardResponse}.
*/
function pvpLeaderboard(pvpSeasonId, bracket) {
return {
namespace: "dynamic",
path: `${wowBasePath}/pvp-season/${pvpSeasonId}/pvp-leaderboard/${bracket}`
};
}
/**
* Get a PvP leaderboard index by PvP season ID.
* @param pvpSeasonId The PvP season ID.
* @returns The PvP leaderboard index. See {@link PvpLeaderboardIndexResponse}.
*/
function pvpLeaderboardIndex(pvpSeasonId) {
return {
namespace: "dynamic",
path: `${wowBasePath}/pvp-season/${pvpSeasonId}/pvp-leaderboard/index`
};
}
/**
* Get a PvP reward index by PvP season ID.
* @param pvpSeasonId The PvP season ID.
* @returns The PvP reward index. See {@link PvpRewardsIndexResponse}.
*/
function pvpRewardsIndex(pvpSeasonId) {
return {
namespace: "dynamic",
path: `${wowBasePath}/pvp-season/${pvpSeasonId}/pvp-reward/index`
};
}
/**
* Get a PvP season by ID.
* @param pvpSeasonId The PvP season ID.
* @returns The PvP season. See {@link PvpSeasonResponse}.
*/
function pvpSeason(pvpSeasonId) {
return {
namespace: "dynamic",
path: `${wowBasePath}/pvp-season/${pvpSeasonId}`
};
}
/**
* Get a PvP season index.
* @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
*/
function pvpSeasonIndex() {
return {
namespace: "dynamic",
path: `${wowBasePath}/pvp-season/index`
};
}
//#endregion
export { pvpLeaderboard, pvpLeaderboardIndex, pvpRewardsIndex, pvpSeason, pvpSeasonIndex };
//# sourceMappingURL=index.js.map