@blizzard-api/classic-wow
Version:
A series of helpers to interact with the World of Warcraft Classic Blizzard API
54 lines (53 loc) • 1.65 kB
JavaScript
//#region src/guild/index.ts
const basePath = "/data/wow/guild";
/**
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
* @param realmSlug The slug of the realm.
* @param nameSlug The lowercase name of the guild.
* @returns a single guild by its name and realm.
*/
function guild(namespace, realmSlug, nameSlug) {
return {
namespace,
path: `${basePath}/${realmSlug}/${nameSlug}`
};
}
/**
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
* @param realmSlug The slug of the realm.
* @param nameSlug The lowercase name of the guild.
* @returns a single guild's achievements by name and realm.
*/
function guildAchievements(namespace, realmSlug, nameSlug) {
return {
namespace,
path: `${basePath}/${realmSlug}/${nameSlug}/achievements`
};
}
/**
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
* @param realmSlug The slug of the realm.
* @param nameSlug The lowercase name of the guild.
* @returns a single guild's activity by name and realm.
*/
function guildActivity(namespace, realmSlug, nameSlug) {
return {
namespace,
path: `${basePath}/${realmSlug}/${nameSlug}/activity`
};
}
/**
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
* @param realmSlug The slug of the realm.
* @param nameSlug The lowercase name of the guild.
* @returns a single guild's roster by its name and realm.
*/
function guildRoster(namespace, realmSlug, nameSlug) {
return {
namespace,
path: `${basePath}/${realmSlug}/${nameSlug}/roster`
};
}
//#endregion
export { guild, guildAchievements, guildActivity, guildRoster };
//# sourceMappingURL=index.js.map