@blizzard-api/wow - npm Package Compare versions

Comparing version 0.2.2 to 0.2.3

dist/index.js

@@ -10,2 +10,7 @@ // src/base.ts
 var achievementApi = {
+  /**
+   * Get an achievement category by ID.
+   * @param achievementCategoryId The achievement category ID.
+   * @returns The achievement category. See {@link AchievementCategoryResponse}.
+   */
   achievementCategory: (achievementCategoryId) => {
@@ -17,2 +22,6 @@ return {
   },
+  /**
+   * Get an achievement category index.
+   * @returns The achievement category index. See {@link AchievementCategoryIndexResponse}.
+   */
   achievementCategoryIndex: () => {
@@ -24,2 +33,7 @@ return {
   },
+  /**
+   * Get an achievement by ID.
+   * @param achievementId The achievement ID.
+   * @returns The achievement. See {@link AchievementResponse}.
+   */
   achievement: (achievementId) => {
@@ -31,2 +45,6 @@ return {
   },
+  /**
+   * Get an achievement index.
+   * @returns The achievement index. See {@link AchievementIndexResponse}.
+   */
   achievementIndex: () => {
@@ -38,2 +56,7 @@ return {
   },
+  /**
+   * Get achievement media by ID.
+   * @param achievementId The achievement ID.
+   * @returns The achievement media. See {@link AchievementMediaResponse}.
+   */
   achievementMedia: (achievementId) => {
@@ -46,2 +69,7 @@ return { path: `${mediaBase}/achievement/${achievementId}`, namespace: "static" };
 var auctionHouseApi = {
+  /**
+   * Get auction house data for a connected realm.
+   * @param connectedRealmId The ID of the connected realm.
+   * @returns The auction house data. See {@link AuctionHouseResponse}.
+   */
   auctions: (connectedRealmId) => {
@@ -53,2 +81,6 @@ return {
   },
+  /**
+   * Get auction house data for all connected realms.
+   * @returns The auction house data. See {@link AuctionHouseResponse}.
+   */
   commodities: () => {
@@ -64,2 +96,7 @@ return {
 var azeriteEssenceApi = {
+  /**
+   * Get an azerite essence by ID.
+   * @param azeriteEssenceId The azerite essence ID.
+   * @returns The azerite essence. See {@link AzeriteEssenceResponse}.
+   */
   azeriteEssence: (azeriteEssenceId) => {
@@ -71,2 +108,6 @@ return {
   },
+  /**
+   * Get an azerite essence index.
+   * @returns The azerite essence index. See {@link AzeriteEssenceIndexResponse}.
+   */
   azeriteEssenceIndex: () => {
@@ -78,5 +119,15 @@ return {
   },
+  /**
+   * Get azerite essence media by ID.
+   * @param azeriteEssenceId The azerite essence ID.
+   * @returns The azerite essence media. See {@link AzeriteEssenceMediaResponse}.
+   */
   azeriteEssenceMedia: (azeriteEssenceId) => {
     return { path: `${mediaBase}/azerite-essence/${azeriteEssenceId}`, namespace: "static" };
   },
+  /**
+   * Search for azerite essences.
+   * @param options The search parameters. See {@link AzeriteEssenceSearchParameters}.
+   * @returns The search results. See {@link SearchResponse}.
+   */
   azeriteEssenceSearch: (options) => {
@@ -97,2 +148,6 @@ return {
 var connectedRealmApi = {
+  /**
+   * Get a connected realm index.
+   * @returns The connected realm index. See {@link ConnectedRealmIndexResponse}.
+   */
   connectedRealmIndex: () => {
@@ -104,2 +159,7 @@ return {
   },
+  /**
+   * Get a connected realm by ID.
+   * @param connectedRealmId The connected realm ID.
+   * @returns The connected realm. See {@link ConnectedRealmResponse}.
+   */
   connectedRealm: (connectedRealmId) => {
@@ -111,2 +171,7 @@ return {
   },
+  /**
+   * Search for connected realms.
+   * @param options The search parameters. See {@link ConnectedRealmSearchParameters}.
+   * @returns The search results. See {@link SearchResponse} & {@link ConnectedRealmSearchResponseItem}.
+   */
   connectedRealmSearch: (options) => {
@@ -128,2 +193,7 @@ return {
 var covenantApi = {
+  /**
+   * Get a conduit by ID.
+   * @param conduitId The conduit ID.
+   * @returns The conduit. See {@link ConduitResponse}.
+   */
   conduit: (conduitId) => {
@@ -135,2 +205,6 @@ return {
   },
+  /**
+   * Get a conduit index.
+   * @returns The conduit index. See {@link ConduitIndexResponse}.
+   */
   conduitIndex: () => {
@@ -142,2 +216,7 @@ return {
   },
+  /**
+   * Get a covenant by ID.
+   * @param covenantId The covenant ID.
+   * @returns The covenant. See {@link CovenantResponse}.
+   */
   covenant: (covenantId) => {
@@ -149,2 +228,6 @@ return {
   },
+  /**
+   * Get a covenant index.
+   * @returns The covenant index. See {@link CovenantIndexResponse}.
+   */
   covenantIndex: () => {
@@ -156,2 +239,7 @@ return {
   },
+  /**
+   * Get covenant media by ID.
+   * @param covenantId The covenant ID.
+   * @returns The covenant media. See {@link CovenantMediaResponse}.
+   */
   covenantMedia: (covenantId) => {
@@ -163,2 +251,7 @@ return {
   },
+  /**
+   * Get a soulbind by ID.
+   * @param soulbindId The soulbind ID.
+   * @returns The soulbind. See {@link SoulbindResponse}.
+   */
   soulbind: (soulbindId) => {
@@ -170,2 +263,6 @@ return {
   },
+  /**
+   * Get a soulbind index.
+   * @returns The soulbind index. See {@link SoulbindIndexResponse}.
+   */
   soulbindIndex: () => {
@@ -181,2 +278,7 @@ return {
 var creatureApi = {
+  /**
+   * Get a creature by ID.
+   * @param creatureId The creature ID.
+   * @returns The creature. See {@link CreatureResponse}.
+   */
   creature: (creatureId) => {
@@ -188,2 +290,7 @@ return {
   },
+  /**
+   * Get creature display media by ID.
+   * @param creatureDisplayId The creature display ID.
+   * @returns The creature display media. See {@link CreatureDisplayMediaResponse}.
+   */
   creatureDisplayMedia: (creatureDisplayId) => {
@@ -195,2 +302,7 @@ return {
   },
+  /**
+   * Get a creature family by ID.
+   * @param creatureFamilyId The creature family ID.
+   * @returns The creature family. See {@link CreatureFamilyResponse}.
+   */
   creatureFamily: (creatureFamilyId) => {
@@ -202,2 +314,6 @@ return {
   },
+  /**
+   * Get a creature family index.
+   * @returns The creature family index. See {@link CreatureFamilyIndexResponse}.
+   */
   creatureFamilyIndex: () => {
@@ -209,2 +325,7 @@ return {
   },
+  /**
+   * Get creature family media by ID.
+   * @param creatureFamilyId The creature family ID.
+   * @returns The creature family media. See {@link CreatureFamilyMediaResponse}.
+   */
   creatureFamilyMedia: (creatureFamilyId) => {
@@ -216,2 +337,7 @@ return {
   },
+  /**
+   * Get a creature type by ID.
+   * @param creatureTypeId The creature type ID.
+   * @returns The creature type. See {@link CreatureTypeResponse}.
+   */
   creatureType: (creatureTypeId) => {
@@ -223,2 +349,6 @@ return {
   },
+  /**
+   * Get a creature type index.
+   * @returns The creature type index. See {@link CreatureTypeIndexResponse}.
+   */
   creatureTypeIndex: () => {
@@ -230,2 +360,7 @@ return {
   },
+  /**
+   * Search for creatures.
+   * @param options The creature search parameters. See {@link CreatureSearchParameters}.
+   * @returns The creature search results. See {@link SearchResponse}.
+   */
   creatureSearch: (options) => {
@@ -246,2 +381,6 @@ return {
 var guildCrestApi = {
+  /**
+   * Get the guild crest components index.
+   * @returns The guild crest components index. See {@link GuildCrestComponentsIndexResponse}.
+   */
   guildCrestComponentsIndex: () => {
@@ -253,2 +392,7 @@ return {
   },
+  /**
+   * Get a guild crest border by ID.
+   * @param borderId The guild crest border ID.
+   * @returns The guild crest border. See {@link GuildCrestBorderEmblemResponse}.
+   */
   guildCrestBorder: (borderId) => {
@@ -260,2 +404,7 @@ return {
   },
+  /**
+   * Get a guild crest emblem by ID.
+   * @param emblemId The guild crest emblem ID.
+   * @returns The guild crest emblem. See {@link GuildCrestBorderEmblemResponse}.
+   */
   guildCrestEmblem: (emblemId) => {
@@ -271,2 +420,7 @@ return {
 var heirloomApi = {
+  /**
+   * Get a heirloom by ID.
+   * @param heirloomId The heirloom ID.
+   * @returns The heirloom. See {@link HeirloomResponse}.
+   */
   heirloom: (heirloomId) => {
@@ -278,2 +432,6 @@ return {
   },
+  /**
+   * Get the heirloom index.
+   * @returns The heirloom index. See {@link HeirloomIndexResponse}.
+   */
   heirloomIndex: () => {
@@ -289,2 +447,7 @@ return {
 var itemApi = {
+  /**
+   * Get an item by ID.
+   * @param itemId The item ID.
+   * @returns The item. See {@link ItemResponse}.
+   */
   item: (itemId) => {
@@ -296,2 +459,7 @@ return {
   },
+  /**
+   * Get an item class by ID.
+   * @param itemClassId The item class ID.
+   * @returns The item class. See {@link ItemClassResponse}.
+   */
   itemClass: (itemClassId) => {
@@ -303,2 +471,8 @@ return {
   },
+  /**
+   * Get an item subclass by ID.
+   * @param itemClassId The item class ID.
+   * @param itemSubclassId The item subclass ID.
+   * @returns The item subclass. See {@link ItemSubClassResponse}.
+   */
   itemSubClass: (itemClassId, itemSubclassId) => {
@@ -310,2 +484,6 @@ return {
   },
+  /**
+   * Get an item class index.
+   * @returns The item class index. See {@link ItemClassIndexResponse}.
+   */
   itemClassIndex: () => {
@@ -317,2 +495,7 @@ return {
   },
+  /**
+   * Get item media by ID.
+   * @param itemId The item ID.
+   * @returns The item media. See {@link ItemMediaResponse}.
+   */
   itemMedia: (itemId) => {
@@ -324,2 +507,7 @@ return {
   },
+  /**
+   * Get an item set by ID.
+   * @param itemSetId The item set ID.
+   * @returns The item set. See {@link ItemSetResponse}.
+   */
   itemSet: (itemSetId) => {
@@ -331,2 +519,6 @@ return {
   },
+  /**
+   * Get an item set index.
+   * @returns The item set index. See {@link ItemSetIndexResponse}.
+   */
   itemSetIndex: () => {
@@ -338,2 +530,7 @@ return {
   },
+  /**
+   * Search for items.
+   * @param options The search parameters. See {@link ItemSearchParameters}.
+   * @returns The search results. See {@link SearchResponse}.
+   */
   itemSearch: (options) => {
@@ -354,2 +551,7 @@ return {
 var journalApi = {
+  /**
+   * Get a journal encounter by ID.
+   * @param journalEncounterId The journal encounter ID.
+   * @returns The journal encounter. See {@link JournalEncounterResponse}.
+   */
   journalEncounter: (journalEncounterId) => {
@@ -361,2 +563,6 @@ return {
   },
+  /**
+   * Get the journal encounter index.
+   * @returns The journal encounter index. See {@link JournalEncounterIndexResponse}.
+   */
   journalEncounterIndex: () => {
@@ -368,2 +574,7 @@ return {
   },
+  /**
+   * Search for journal encounters.
+   * @param options The search parameters. See {@link JournalEncounterSearchParameters}.
+   * @returns The search results. See {@link SearchResponse}.
+   */
   journalEncounterSearch: (options) => {
@@ -380,2 +591,7 @@ return {
   },
+  /**
+   * Get a journal expansion by ID.
+   * @param journalExpansionId The journal expansion ID.
+   * @returns The journal expansion. See {@link JournalExpansionResponse}.
+   */
   journalExpansion: (journalExpansionId) => {
@@ -387,2 +603,6 @@ return {
   },
+  /**
+   * Get the journal expansion index.
+   * @returns The journal expansion index. See {@link JournalExpansionIndexResponse}.
+   */
   journalExpansionIndex: () => {
@@ -394,2 +614,7 @@ return {
   },
+  /**
+   * Get a journal instance by ID.
+   * @param journalInstanceId The journal instance ID.
+   * @returns The journal instance. See {@link JournalInstanceResponse}.
+   */
   journalInstance: (journalInstanceId) => {
@@ -401,2 +626,6 @@ return {
   },
+  /**
+   * Get the journal instance index.
+   * @returns The journal instance index. See {@link JournalInstanceIndexResponse}.
+   */
   journalInstanceIndex: () => {
@@ -408,2 +637,7 @@ return {
   },
+  /**
+   * Get journal instance media by ID.
+   * @param journalInstanceId The journal instance ID.
+   * @returns The journal instance media. See {@link JournalInstanceMediaResponse}.
+   */
   journalInstanceMedia: (journalInstanceId) => {
@@ -419,2 +653,7 @@ return {
 var mediaSearchApi = {
+  /**
+   * Search for media.
+   * @param options The search parameters. See {@link MediaSearchParameters}.
+   * @returns The search results. See {@link SearchResponse}.
+   */
   mediaSearch: (options) => {
@@ -435,2 +674,7 @@ return {
 var modifiedCraftingApi = {
+  /**
+   * Get a modified crafting category by ID.
+   * @param modifiedCraftingCategoryId The modified crafting category ID.
+   * @returns The modified crafting category. See {@link ModifiedCraftingCategoryResponse}.
+   */
   modifiedCraftingCategory: (modifiedCraftingCategoryId) => {
@@ -442,2 +686,6 @@ return {
   },
+  /**
+   * Get a modified crafting category index.
+   * @returns The modified crafting category index. See {@link ModifiedCraftingCategoryIndexResponse}.
+   */
   modifiedCraftingCategoryIndex: () => {
@@ -449,2 +697,6 @@ return {
   },
+  /**
+   * Get a modified crafting index.
+   * @returns The modified crafting index. See {@link ModifiedCraftingIndexResponse}.
+   */
   modifiedCraftingIndex: () => {
@@ -456,2 +708,7 @@ return {
   },
+  /**
+   * Get a modified crafting reagent slot type by ID.
+   * @param modifiedCraftingReagentSlotTypeId The modified crafting reagent slot type ID.
+   * @returns The modified crafting reagent slot type. See {@link ModifiedCraftingReagentSlotTypeResponse}.
+   */
   modifiedCraftingReagentSlotType: (modifiedCraftingReagentSlotTypeId) => {
@@ -463,2 +720,6 @@ return {
   },
+  /**
+   * Get a modified crafting reagent slot type index.
+   * @returns The modified crafting reagent slot type index. See {@link ModifiedCraftingReagentSlotTypeIndexResponse}.
+   */
   modifiedCraftingReagentSlotTypeIndex: () => {
@@ -474,2 +735,7 @@ return {
 var mountApi = {
+  /**
+   * Get a mount by ID.
+   * @param mountId The mount ID.
+   * @returns The mount. See {@link MountResponse}.
+   */
   mount: (mountId) => {
@@ -481,2 +747,6 @@ return {
   },
+  /**
+   * Get a mount index.
+   * @returns The mount index. See {@link MountIndexResponse}.
+   */
   mountIndex: () => {
@@ -488,2 +758,7 @@ return {
   },
+  /**
+   * Get a mount search.
+   * @param options The search parameters. See {@link MountSearchParameters}.
+   * @returns The search results. See {@link SearchResponse}.
+   */
   mountSearch: (options) => {
@@ -504,2 +779,6 @@ return {
 var mythicKeystoneAffixApi = {
+  /**
+   * Get a list of all Mythic Keystone affixes.
+   * @returns A list of all Mythic Keystone affixes. See {@link MythicKeystoneAffixIndexResponse}
+   */
   mythicKeystoneAffix: (mythicKeystoneAffixId) => {
@@ -511,2 +790,6 @@ return {
   },
+  /**
+   * Get a list of all Mythic Keystone affixes.
+   * @returns A list of all Mythic Keystone affixes. See {@link MythicKeystoneAffixIndexResponse}
+   */
   mythicKeystoneAffixIndex: () => {
@@ -518,2 +801,6 @@ return {
   },
+  /**
+   * Get a list of all Mythic Keystone affix media.
+   * @returns A list of all Mythic Keystone affix media. See {@link MythicKeystoneAffixMediaResponse}
+   */
   mythicKeystoneAffixMedia: (mythicKeystoneAffixId) => {
@@ -529,2 +816,7 @@ return {
 var mythicKeystoneDungeonApi = {
+  /**
+   * Get a Mythic Keystone dungeon by ID.
+   * @param mythicKeystoneDungeonId The Mythic Keystone dungeon ID.
+   * @returns The Mythic Keystone dungeon. See {@link MythicKeystoneDungeonResponse}.
+   */
   mythicKeystoneDungeon: (mythicKeystoneDungeonId) => {
@@ -536,2 +828,6 @@ return {
   },
+  /**
+   * Get a Mythic Keystone dungeon index.
+   * @returns The Mythic Keystone dungeon index. See {@link MythicKeystoneDungeonIndexResponse}.
+   */
   mythicKeystoneDungeonIndex: () => {
@@ -543,2 +839,6 @@ return {
   },
+  /**
+   * Get a Mythic Keystone index.
+   * @returns The Mythic Keystone index. See {@link MythicKeystoneIndexResponse}.
+   */
   mythicKeystoneIndex: () => {
@@ -550,2 +850,7 @@ return {
   },
+  /**
+   * Get a Mythic Keystone period by ID.
+   * @param mythicKeystonePeriodId The Mythic Keystone period ID.
+   * @returns The Mythic Keystone period. See {@link MythicKeystonePeriodResponse}.
+   */
   mythicKeystonePeriod: (mythicKeystonePeriodId) => {
@@ -557,2 +862,6 @@ return {
   },
+  /**
+   * Get a Mythic Keystone period index.
+   * @returns The Mythic Keystone period index. See {@link MythicKeystonePeriodIndexResponse}.
+   */
   mythicKeystonePeriodIndex: () => {
@@ -564,2 +873,7 @@ return {
   },
+  /**
+   * Get a Mythic Keystone season by ID.
+   * @param mythicKeystoneSeasonId The Mythic Keystone season ID.
+   * @returns The Mythic Keystone season. See {@link MythicKeystoneSeasonResponse}.
+   */
   mythicKeystoneSeason: (mythicKeystoneSeasonId) => {
@@ -571,2 +885,6 @@ return {
   },
+  /**
+   * Get a Mythic Keystone season index.
+   * @returns The Mythic Keystone season index. See {@link MythicKeystoneSeasonIndexResponse}.
+   */
   mythicKeystoneSeasonIndex: () => {
@@ -582,2 +900,9 @@ return {
 var mythicKeystoneLeaderboardApi = {
+  /**
+   * Get a Mythic Keystone leaderboard by connected realm ID, dungeon ID, and period.
+   * @param connectedRealmId The connected realm ID.
+   * @param dungeonId The dungeon ID.
+   * @param period The period ID.
+   * @returns The Mythic Keystone leaderboard. See {@link MythicKeystoneLeaderboardResponse}.
+   */
   mythicKeystoneLeaderboard: (connectedRealmId, dungeonId, period) => {
@@ -589,2 +914,7 @@ return {
   },
+  /**
+   * Get a Mythic Keystone leaderboard index by connected realm ID.
+   * @param connectedRealmId The connected realm ID.
+   * @returns The Mythic Keystone leaderboard index. See {@link MythicKeystoneLeaderboardIndexResponse}.
+   */
   mythicKeystoneLeaderboardIndex: (connectedRealmId) => {
@@ -600,2 +930,8 @@ return {
 var mythicRaidLeaderboardApi = {
+  /**
+   * Get a Mythic Raid leaderboard by raid and faction.
+   * @param raid The slug of the raid.
+   * @param faction The faction. Either 'alliance' or 'horde'.
+   * @returns The Mythic Raid leaderboard. See {@link MythicRaidLeaderboardResponse}.
+   */
   mythicRaidLeaderboard: (raid, faction) => {
@@ -611,2 +947,7 @@ return {
 var petApi = {
+  /**
+   * Get a pet by ID.
+   * @param petId The pet ID.
+   * @returns The pet. See {@link PetResponse}.
+   */
   pet: (petId) => {
@@ -618,2 +959,6 @@ return {
   },
+  /**
+   * Get a pet index.
+   * @returns The pet index. See {@link PetIndexResponse}.
+   */
   petIndex: () => {
@@ -625,2 +970,7 @@ return {
   },
+  /**
+   * Get a pet media by ID.
+   * @param petId The pet ID.
+   * @returns The pet media. See {@link PetMediaResponse}.
+   */
   petMedia: (petId) => {
@@ -632,2 +982,7 @@ return {
   },
+  /**
+   * Get a pet ability by ID.
+   * @param petAbilityId The pet ability ID.
+   * @returns The pet ability. See {@link PetAbilityResponse}.
+   */
   petAbility: (petAbilityId) => {
@@ -639,2 +994,6 @@ return {
   },
+  /**
+   * Get a pet ability index.
+   * @returns The pet ability index. See {@link PetAbilityIndexResponse}.
+   */
   petAbilityIndex: () => {
@@ -646,2 +1005,7 @@ return {
   },
+  /**
+   * Get a pet ability media by ID.
+   * @param petAbilityId The pet ability ID.
+   * @returns The pet ability media. See {@link PetAbilityMediaResponse}.
+   */
   petAbilityMedia: (petAbilityId) => {
@@ -657,2 +1021,7 @@ return {
 var playableClassApi = {
+  /**
+   * Get a playable class by ID.
+   * @param playableClassId The playable class ID.
+   * @returns The playable class. See {@link PlayableClassResponse}.
+   */
   playableClass: (playableClassId) => {
@@ -664,2 +1033,6 @@ return {
   },
+  /**
+   * Get a playable class index.
+   * @returns The playable class index. See {@link PlayableClassIndexResponse}.
+   */
   playableClassIndex: () => {
@@ -671,2 +1044,7 @@ return {
   },
+  /**
+   * Get playable class media by ID.
+   * @param playableClassId The playable class ID.
+   * @returns The playable class media. See {@link PlayableClassMediaResponse}.
+   */
   playableClassMedia: (playableClassId) => {
@@ -678,2 +1056,7 @@ return {
   },
+  /**
+   * Get a playable class's PvP talent slots by ID.
+   * @param playableClassId The playable class ID.
+   * @returns The playable class's PvP talent slots. See {@link PvpTalentSlotsResponse}.
+   */
   pvpTalentSlots: (playableClassId) => {
@@ -689,2 +1072,7 @@ return {
 var playableRaceApi = {
+  /**
+   * Get a playable race by ID.
+   * @param playableRaceId The playable race ID.
+   * @returns The playable race. See {@link PlayableRaceResponse}.
+   */
   playableRace: (playableRaceId) => {
@@ -696,2 +1084,6 @@ return {
   },
+  /**
+   * Get a playable race index.
+   * @returns The playable race index. See {@link PlayableRaceIndexResponse}.
+   */
   playableRaceIndex: () => {
@@ -707,2 +1099,7 @@ return {
 var playableSpecializationApi = {
+  /**
+   * Get a playable specialization by ID.
+   * @param specializationId The playable specialization ID.
+   * @returns The playable specialization. See {@link PlayableSpecializationResponse}.
+   */
   playableSpecialization: (specializationId) => {
@@ -714,2 +1111,6 @@ return {
   },
+  /**
+   * Get a playable specialization index.
+   * @returns The playable specialization index. See {@link PlayableSpecializationIndexResponse}.
+   */
   playableSpecializationIndex: () => {
@@ -721,2 +1122,7 @@ return {
   },
+  /**
+   * Get a playable specialization media by ID.
+   * @param specializationId The playable specialization ID.
+   * @returns The playable specialization media. See {@link PlayableSpecializationMediaResponse}.
+   */
   playableSpecializationMedia: (specializationId) => {
@@ -732,2 +1138,7 @@ return {
 var powerTypeApi = {
+  /**
+   * Get a power type by ID.
+   * @param powerTypeId The power type ID.
+   * @returns The power type. See {@link PowerTypeResponse}.
+   */
   powerType: (powerTypeId) => {
@@ -739,2 +1150,6 @@ return {
   },
+  /**
+   * Get a power type index.
+   * @returns The power type index. See {@link PowerTypeIndexResponse}.
+   */
   powerTypeIndex: () => {
@@ -750,2 +1165,7 @@ return {
 var professionApi = {
+  /**
+   * Get a profession by ID.
+   * @param professionId The profession ID.
+   * @returns The profession. See {@link ProfessionResponse}.
+   */
   profession: (professionId) => {
@@ -757,2 +1177,6 @@ return {
   },
+  /**
+   * Get a profession index.
+   * @returns The profession index. See {@link ProfessionIndexResponse}.
+   */
   professionIndex: () => {
@@ -764,2 +1188,7 @@ return {
   },
+  /**
+   * Get profession media by ID.
+   * @param professionId The profession ID.
+   * @returns The profession media. See {@link ProfessionMediaResponse}.
+   */
   professionMedia: (professionId) => {
@@ -771,2 +1200,8 @@ return {
   },
+  /**
+   * Get a profession's skill tier by ID.
+   * @param professionId The profession ID.
+   * @param skillTierId The skill tier ID.
+   * @returns The profession's skill tier. See {@link ProfessionSkillTierResponse}.
+   */
   professionSkillTier: (professionId, skillTierId) => {
@@ -778,2 +1213,7 @@ return {
   },
+  /**
+   * Get a recipe by ID.
+   * @param recipeId The recipe ID.
+   * @returns The recipe. See {@link RecipeResponse}.
+   */
   recipe: (recipeId) => {
@@ -785,2 +1225,7 @@ return {
   },
+  /**
+   * Get recipe media by ID.
+   * @param recipeId The recipe ID.
+   * @returns The recipe media. See {@link RecipeMediaResponse}.
+   */
   recipeMedia: (recipeId) => {
@@ -796,2 +1241,8 @@ return {
 var pvpSeasonApi = {
+  /**
+   * 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}.
+   */
   pvpLeaderboard: (pvpSeasonId, bracket) => {
@@ -803,2 +1254,7 @@ return {
   },
+  /**
+   * Get a PvP leaderboard index by PvP season ID.
+   * @param pvpSeasonId The PvP season ID.
+   * @returns The PvP leaderboard index. See {@link PvpLeaderboardIndexResponse}.
+   */
   pvpLeaderboardIndex: (pvpSeasonId) => {
@@ -810,2 +1266,7 @@ return {
   },
+  /**
+   * Get a PvP reward index by PvP season ID.
+   * @param pvpSeasonId The PvP season ID.
+   * @returns The PvP reward index. See {@link PvpRewardsIndexResponse}.
+   */
   pvpRewardsIndex: (pvpSeasonId) => {
@@ -817,2 +1278,7 @@ return {
   },
+  /**
+   * Get a PvP season by ID.
+   * @param pvpSeasonId The PvP season ID.
+   * @returns The PvP season. See {@link PvpSeasonResponse}.
+   */
   pvpSeason: (pvpSeasonId) => {
@@ -824,2 +1290,6 @@ return {
   },
+  /**
+   * Get a PvP season index.
+   * @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
+   */
   pvpSeasonIndex: () => {
@@ -835,2 +1305,7 @@ return {
 var pvpTierApi = {
+  /**
+   * Get a PvP tier by ID.
+   * @param pvpTierId The PvP tier ID.
+   * @returns The PvP tier. See {@link PvpTierResponse}.
+   */
   pvpTier: (pvpTierId) => {
@@ -842,2 +1317,6 @@ return {
   },
+  /**
+   * Get a PvP tier index.
+   * @returns The PvP tier index. See {@link PvpTierIndexResponse}.
+   */
   pvpTierIndex: () => {
@@ -849,2 +1328,7 @@ return {
   },
+  /**
+   * Get PvP tier media by ID.
+   * @param pvpTierId The PvP tier ID.
+   * @returns The PvP tier media. See {@link PvpTierMediaResponse}.
+   */
   pvpTierMedia: (pvpTierId) => {
@@ -860,2 +1344,7 @@ return {
 var questApi = {
+  /**
+   * Get a quest by ID.
+   * @param questId The quest ID.
+   * @returns The quest. See {@link QuestResponse}.
+   */
   quest: (questId) => {
@@ -867,2 +1356,6 @@ return {
   },
+  /**
+   * Get a quest index.
+   * @returns The quest index. See {@link QuestIndexResponse}.
+   */
   questIndex: () => {
@@ -874,2 +1367,7 @@ return {
   },
+  /**
+   * Get a quest area by ID.
+   * @param questAreaId The quest area ID.
+   * @returns The quest area. See {@link QuestAreaResponse}.
+   */
   questArea: (questAreaId) => {
@@ -881,2 +1379,6 @@ return {
   },
+  /**
+   * Get a quest area index.
+   * @returns The quest area index. See {@link QuestAreaIndexResponse}.
+   */
   questAreaIndex: () => {
@@ -888,2 +1390,7 @@ return {
   },
+  /**
+   * Get a quest category by ID.
+   * @param questCategoryId The quest category ID.
+   * @returns The quest category. See {@link QuestCategoryResponse}.
+   */
   questCategory: (questCategoryId) => {
@@ -895,2 +1402,6 @@ return {
   },
+  /**
+   * Get a quest category index.
+   * @returns The quest category index. See {@link QuestCategoryIndexResponse}.
+   */
   questCategoryIndex: () => {
@@ -902,2 +1413,7 @@ return {
   },
+  /**
+   * Get a quest type by ID.
+   * @param questTypeId The quest type ID.
+   * @returns The quest type. See {@link QuestTypeResponse}.
+   */
   questType: (questTypeId) => {
@@ -909,2 +1425,6 @@ return {
   },
+  /**
+   * Get a quest type index.
+   * @returns The quest type index. See {@link QuestTypeIndexResponse}.
+   */
   questTypeIndex: () => {
@@ -920,2 +1440,7 @@ return {
 var realmApi = {
+  /**
+   * Get a realm by slug.
+   * @param realmSlug The realm slug.
+   * @returns The realm. See {@link RealmResponse}.
+   */
   realm: (realmSlug) => {
@@ -927,2 +1452,6 @@ return {
   },
+  /**
+   * Get a realm index.
+   * @returns The realm index. See {@link RealmIndexResponse}.
+   */
   realmIndex: () => {
@@ -934,2 +1463,7 @@ return {
   },
+  /**
+   * Search for realms.
+   * @param options The search parameters. See {@link RealmSearchParameters}.
+   * @returns The search results. See {@link SearchResponse}.
+   */
   realmSearch: (options) => {
@@ -950,2 +1484,7 @@ return {
 var regionApi = {
+  /**
+   * Get a region by ID.
+   * @param regionId The region ID.
+   * @returns The region. See {@link RegionResponse}.
+   */
   region: (regionId) => {
@@ -957,2 +1496,6 @@ return {
   },
+  /**
+   * Get a region index.
+   * @returns The region index. See {@link RegionIndexResponse}.
+   */
   regionIndex: () => {
@@ -968,2 +1511,7 @@ return {
 var reputationApi = {
+  /**
+   * Get a reputation faction by ID.
+   * @param reputationFactionId The reputation faction ID.
+   * @returns The reputation faction. See {@link ReputationFactionResponse}.
+   */
   reputationFaction: (reputationFactionId) => {
@@ -975,2 +1523,6 @@ return {
   },
+  /**
+   * Get a reputation faction index.
+   * @returns The reputation faction index. See {@link ReputationFactionIndexResponse}.
+   */
   reputationFactionIndex: () => {
@@ -982,2 +1534,7 @@ return {
   },
+  /**
+   * Get a reputation tier by ID.
+   * @param reputationTiersId The reputation tier ID.
+   * @returns The reputation tier. See {@link ReputationTiersResponse}.
+   */
   reputationTiers: (reputationTiersId) => {
@@ -989,2 +1546,6 @@ return {
   },
+  /**
+   * Get a reputation tier index.
+   * @returns The reputation tier index. See {@link ReputationTiersIndexResponse}.
+   */
   reputationTiersIndex: () => {
@@ -1000,2 +1561,7 @@ return {
 var spellApi = {
+  /**
+   * Get a spell by ID.
+   * @param spellId The spell ID.
+   * @returns The spell. See {@link SpellResponse}.
+   */
   spell: (spellId) => {
@@ -1007,2 +1573,7 @@ return {
   },
+  /**
+   * Get spell media by ID.
+   * @param spellId The spell ID.
+   * @returns The spell media. See {@link SpellMediaResponse}.
+   */
   spellMedia: (spellId) => {
@@ -1014,2 +1585,7 @@ return {
   },
+  /**
+   * Get a spell search.
+   * @param options The spell search options. See {@link SpellSearchParameters}.
+   * @returns The spell search. See {@link SearchResponse}.
+   */
   spellSearch: (options) => {
@@ -1030,2 +1606,7 @@ return {
 var talentApi = {
+  /**
+   * Get a PvP talent by ID.
+   * @param pvpTalentId The PvP talent ID.
+   * @returns The PvP talent. See {@link PvpTalentResponse}.
+   */
   pvpTalent: (pvpTalentId) => {
@@ -1037,2 +1618,6 @@ return {
   },
+  /**
+   * Get a PvP talent index.
+   * @returns The PvP talent index. See {@link PvpTalentIndexResponse}.
+   */
   pvpTalentIndex: () => {
@@ -1044,2 +1629,7 @@ return {
   },
+  /**
+   * Get a talent by ID.
+   * @param talentId The talent ID.
+   * @returns The talent. See {@link TalentResponse}.
+   */
   talent: (talentId) => {
@@ -1051,2 +1641,6 @@ return {
   },
+  /**
+   * Get a talent index.
+   * @returns The talent index. See {@link TalentIndexResponse}.
+   */
   talentIndex: () => {
@@ -1058,2 +1652,8 @@ return {
   },
+  /**
+   * Get a talent tree by ID.
+   * @param talentTreeId The talent tree ID.
+   * @param specId The playable specialization ID.
+   * @returns The talent tree. See {@link TalentTreeResponse}.
+   */
   talentTree: (talentTreeId, specId) => {
@@ -1065,2 +1665,6 @@ return {
   },
+  /**
+   * Get a talent tree index.
+   * @returns The talent tree index. See {@link TalentTreeIndexResponse}.
+   */
   talentTreeIndex: () => {
@@ -1072,2 +1676,7 @@ return {
   },
+  /**
+   * Get talent tree nodes by talent tree ID.
+   * @param talentTreeId The talent tree ID.
+   * @returns The talent tree nodes. See {@link TalentTreeNodesResponse}.
+   */
   talentTreeNodes: (talentTreeId) => {
@@ -1083,2 +1692,7 @@ return {
 var techTalentApi = {
+  /**
+   * Get a tech talent by ID.
+   * @param techTalentId The tech talent ID.
+   * @returns The tech talent. See {@link TechTalentResponse}.
+   */
   techTalent: (techTalentId) => {
@@ -1090,2 +1704,6 @@ return {
   },
+  /**
+   * Get a tech talent index.
+   * @returns The tech talent index. See {@link TechTalentIndexResponse}.
+   */
   techTalentIndex: () => {
@@ -1097,2 +1715,7 @@ return {
   },
+  /**
+   * Get tech talent media by ID.
+   * @param techTalentId The tech talent ID.
+   * @returns The tech talent media. See {@link TechTalentMediaResponse}.
+   */
   techTalentMedia: (techTalentId) => {
@@ -1104,2 +1727,7 @@ return {
   },
+  /**
+   * Get a tech talent tree by ID.
+   * @param techTalentTreeId The tech talent tree ID.
+   * @returns The tech talent tree. See {@link TechTalentTreeResponse}.
+   */
   techTalentTree: (techTalentTreeId) => {
@@ -1111,2 +1739,6 @@ return {
   },
+  /**
+   * Get a tech talent tree index.
+   * @returns The tech talent tree index. See {@link TechTalentTreeIndexResponse}.
+   */
   techTalentTreeIndex: () => {
@@ -1122,2 +1754,7 @@ return {
 var titleApi = {
+  /**
+   * Get a title by ID.
+   * @param titleId The title ID.
+   * @returns The title. See {@link TitleResponse}.
+   */
   title: (titleId) => {
@@ -1129,2 +1766,6 @@ return {
   },
+  /**
+   * Get a title index.
+   * @returns The title index. See {@link TitleIndexResponse}.
+   */
   titleIndex: () => {
@@ -1140,2 +1781,7 @@ return {
 var toyApi = {
+  /**
+   * Get a toy by ID.
+   * @param toyId The toy ID.
+   * @returns The toy. See {@link ToyResponse}.
+   */
   toy: (toyId) => {
@@ -1147,2 +1793,6 @@ return {
   },
+  /**
+   * Get a toy index.
+   * @returns The toy index. See {@link ToyIndexResponse}.
+   */
   toyIndex: () => {
@@ -1158,2 +1808,6 @@ return {
 var wowTokenApi = {
+  /**
+   * Get the current WoW token price.
+   * @returns The WoW token price. See {@link WowTokenResponse}.
+   */
   wowToken: () => {
@@ -1160,0 +1814,0 @@ return {

package.json

 {
   "name": "@blizzard-api/wow",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "license": "MIT",
@@ -10,3 +10,3 @@ "author": "Putro",
   "engines": {
-    "node": ">=18 <19 || >=20"
+    "node": "^18.18 || ^20.9 || ^21.1 || ^22"
   },
@@ -49,6 +49,6 @@ "main": "./dist/index.js",
   "peerDependencies": {
-    "@blizzard-api/core": "0.1.0"
+    "@blizzard-api/core": "0.1.1"
   },
   "devDependencies": {
-    "@blizzard-api/core": "0.1.0"
+    "@blizzard-api/core": "0.1.1"
   },
@@ -55,0 +55,0 @@ "scripts": {

No alert changes

Improved metrics

Total package byte prevSize

490142

increased by41.47%

Lines of code

6573

increased by42.55%

No dependency changes