@blizzard-api/wow - npm Package Compare versions

Comparing version 1.1.2 to 1.1.3

dist/index.js

@@ -1135,5 +1135,6 @@ // src/base.ts
 };
+var src_default = wow;
 
-export { achievement, achievementCategory, achievementCategoryIndex, achievementIndex, achievementMedia, auctions, azeriteEssence, azeriteEssenceIndex, azeriteEssenceMedia, azeriteEssenceSearch, commodities, conduit, conduitIndex, connectedRealm, connectedRealmIndex, connectedRealmSearch, covenant, covenantIndex, covenantMedia, creature, creatureDisplayMedia, creatureFamily, creatureFamilyIndex, creatureFamilyMedia, creatureSearch, creatureType, creatureTypeIndex, guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem, heirloom, heirloomIndex, item, itemClass, itemClassIndex, itemMedia, itemSearch, itemSet, itemSetIndex, itemSubClass, journalEncounter, journalEncounterIndex, journalEncounterSearch, journalExpansion, journalExpansionIndex, journalInstance, journalInstanceIndex, journalInstanceMedia, mediaSearch, modifiedCraftingCategory, modifiedCraftingCategoryIndex, modifiedCraftingIndex, modifiedCraftingReagentSlotType, modifiedCraftingReagentSlotTypeIndex, mount, mountIndex, mountSearch, mythicKeystoneAffix, mythicKeystoneAffixIndex, mythicKeystoneAffixMedia, mythicKeystoneDungeon, mythicKeystoneDungeonIndex, mythicKeystoneIndex, mythicKeystoneLeaderboard, mythicKeystoneLeaderboardIndex, mythicKeystonePeriod, mythicKeystonePeriodIndex, mythicKeystoneSeason, mythicKeystoneSeasonIndex, mythicRaidLeaderboard, pet, petAbility, petAbilityIndex, petAbilityMedia, petIndex, petMedia, playableClass, playableClassIndex, playableClassMedia, playableRace, playableRaceIndex, playableSpecialization, playableSpecializationIndex, playableSpecializationMedia, powerType, powerTypeIndex, profession, professionIndex, professionMedia, professionSkillTier, pvpLeaderboard, pvpLeaderboardIndex, pvpRewardsIndex, pvpSeason, pvpSeasonIndex, pvpTalent, pvpTalentIndex, pvpTalentSlots, pvpTier, pvpTierIndex, pvpTierMedia, quest, questArea, questAreaIndex, questCategory, questCategoryIndex, questIndex, questType, questTypeIndex, realm, realmIndex, realmSearch, recipe, recipeMedia, region, regionIndex, reputationFaction, reputationFactionIndex, reputationTiers, reputationTiersIndex, soulbind, soulbindIndex, spell, spellMedia, spellSearch, talent, talentIndex, talentTree, talentTreeIndex, talentTreeNodes, techTalent, techTalentIndex, techTalentMedia, techTalentTree, techTalentTreeIndex, title, titleIndex, toy, toyIndex, wow, wowToken };
+export { achievement, achievementCategory, achievementCategoryIndex, achievementIndex, achievementMedia, auctions, azeriteEssence, azeriteEssenceIndex, azeriteEssenceMedia, azeriteEssenceSearch, commodities, conduit, conduitIndex, connectedRealm, connectedRealmIndex, connectedRealmSearch, covenant, covenantIndex, covenantMedia, creature, creatureDisplayMedia, creatureFamily, creatureFamilyIndex, creatureFamilyMedia, creatureSearch, creatureType, creatureTypeIndex, src_default as default, guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem, heirloom, heirloomIndex, item, itemClass, itemClassIndex, itemMedia, itemSearch, itemSet, itemSetIndex, itemSubClass, journalEncounter, journalEncounterIndex, journalEncounterSearch, journalExpansion, journalExpansionIndex, journalInstance, journalInstanceIndex, journalInstanceMedia, mediaSearch, modifiedCraftingCategory, modifiedCraftingCategoryIndex, modifiedCraftingIndex, modifiedCraftingReagentSlotType, modifiedCraftingReagentSlotTypeIndex, mount, mountIndex, mountSearch, mythicKeystoneAffix, mythicKeystoneAffixIndex, mythicKeystoneAffixMedia, mythicKeystoneDungeon, mythicKeystoneDungeonIndex, mythicKeystoneIndex, mythicKeystoneLeaderboard, mythicKeystoneLeaderboardIndex, mythicKeystonePeriod, mythicKeystonePeriodIndex, mythicKeystoneSeason, mythicKeystoneSeasonIndex, mythicRaidLeaderboard, pet, petAbility, petAbilityIndex, petAbilityMedia, petIndex, petMedia, playableClass, playableClassIndex, playableClassMedia, playableRace, playableRaceIndex, playableSpecialization, playableSpecializationIndex, playableSpecializationMedia, powerType, powerTypeIndex, profession, professionIndex, professionMedia, professionSkillTier, pvpLeaderboard, pvpLeaderboardIndex, pvpRewardsIndex, pvpSeason, pvpSeasonIndex, pvpTalent, pvpTalentIndex, pvpTalentSlots, pvpTier, pvpTierIndex, pvpTierMedia, quest, questArea, questAreaIndex, questCategory, questCategoryIndex, questIndex, questType, questTypeIndex, realm, realmIndex, realmSearch, recipe, recipeMedia, region, regionIndex, reputationFaction, reputationFactionIndex, reputationTiers, reputationTiersIndex, soulbind, soulbindIndex, spell, spellMedia, spellSearch, talent, talentIndex, talentTree, talentTreeIndex, talentTreeNodes, techTalent, techTalentIndex, techTalentMedia, techTalentTree, techTalentTreeIndex, title, titleIndex, toy, toyIndex, wow, wowToken };
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@blizzard-api/wow",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "license": "MIT",
@@ -5,0 +5,0 @@ "author": "Putro",

README.md

@@ -17,7 +17,20 @@ # @blizzard-api/wow
 import { wow } from "@blizzard-api/wow"
+//or
+import wow from "@blizzard-api/wow"
 
 const achievement = wow.achievement(123);
-        ^ { path: string, namespace: string }
+        ^ { path: string, namespace?: string, parameters?: Record<string, never> }
 ```
 
+If you don't want to use the exported wow object, you can also access the functions directly:
+
+```ts
+import { achievement } from "@blizzard-api/wow"
+
+const achi = achievement(123);
+        ^ { path: string, namespace?: string, parameters?: Record<string, never> }
+```
+
+### Types
+
 If you need the response types, they are also exported with "Response" appended, so to get the response type from the above code, you can import it like this:
@@ -29,22 +42,14 @@
 
-If you simply want to use the existing object, you can use the helper from `@blizzard-api/core` like so:
+If you simply want to use the existing object, you can use the helper, `ExtractResourceType`, from `@blizzard-api/core` like so:
 
 ```ts
+import type { ExtractResourceType } from "@blizzard-api/core";
 import { wow } from "@blizzard-api/wow"
 
 const achievement = wow.achievement(123);
-        ^ { path: string, namespace: string }
+        ^ { path: string, namespace?: string, parameters?: Record<string, never> }
+
 type AchievementResponse = ExtractResourceType<typeof achievement>;
 ```
 
-If you don't want to use the exported wow object, you can also access the functions directly:
-
-```ts
-import { achievement } from "@blizzard-api/wow"
-
-const achi = achievement(123);
-        ^ { path: string, namespace: string }
-type AchievementResponse = ExtractResourceType<typeof achi>;
-```
-
 ## Differences to @blizzard-api/classic-wow
@@ -54,7 +59,7 @@
 
-## Types
+## Notes on Types
 
 The types are manually created from using the Blizzard API documentation, and are as accurate as possible with smoke testing each endpoint. However, no-one is perfect so there is likely be some discrepancies. If you encounter any issues with the types from this package, please open an issue or a pull request.
 
-### Client
+## Client
 
@@ -61,0 +66,0 @@ While this package is made to function on it's own, it performs even better when combined with `@blizzard-api/client` where you can easily request data combining the two libraries.

No alert changes

Improved metrics

Total package byte prevSize

463192

increased by0.1%

Lines of code

5631

increased by0.07%

Number of lines in readme file

81

increased by6.58%

No dependency changes