UNPKG

@blizzard-api/wow

Version:

A series of helpers to interact with the World of Warcraft Blizzard API

72 lines (71 loc) 2.45 kB
//#region src/character-collections/index.ts const basePath = "/profile/wow/character"; /** * @param realmSlug The slug of the realm. * @param characterName The lowercase name of the character. * @returns an index of collection types for a character. */ function characterCollectionsIndex(realmSlug, characterName) { return { namespace: "profile", path: `${basePath}/${realmSlug}/${characterName}/collections` }; } /** * @param realmSlug The slug of the realm. * @param characterName The lowercase name of the character. * @returns a summary of the heirlooms a character has obtained. */ function characterHeirloomsCollectionSummary(realmSlug, characterName) { return { namespace: "profile", path: `${basePath}/${realmSlug}/${characterName}/collections/heirlooms` }; } /** * @param realmSlug The slug of the realm. * @param characterName The lowercase name of the character. * @returns a summary of the mounts a character has obtained. */ function characterMountsCollectionSummary(realmSlug, characterName) { return { namespace: "profile", path: `${basePath}/${realmSlug}/${characterName}/collections/mounts` }; } /** * @param realmSlug The slug of the realm. * @param characterName The lowercase name of the character. * @returns a summary of the battle pets a character has obtained. */ function characterPetsCollectionSummary(realmSlug, characterName) { return { namespace: "profile", path: `${basePath}/${realmSlug}/${characterName}/collections/pets` }; } /** * @param realmSlug The slug of the realm. * @param characterName The lowercase name of the character. * @returns a summary of the toys a character has obtained. */ function characterToysCollectionSummary(realmSlug, characterName) { return { namespace: "profile", path: `${basePath}/${realmSlug}/${characterName}/collections/toys` }; } /** * @param realmSlug The slug of the realm. * @param characterName The lowercase name of the character. * @returns a summary of the transmog unlocks a character has obtained. */ function characterTransmogCollectionSummary(realmSlug, characterName) { return { namespace: "profile", path: `${basePath}/${realmSlug}/${characterName}/collections/transmogs` }; } //#endregion export { characterCollectionsIndex, characterHeirloomsCollectionSummary, characterMountsCollectionSummary, characterPetsCollectionSummary, characterToysCollectionSummary, characterTransmogCollectionSummary }; //# sourceMappingURL=index.js.map