poe-api-manager 0.2.2 → 0.2.8

package/lib/modules/poe.watch/allModules/submodules/UniqueMapsModule.js

@@ -1,13 +1,59 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Unique Maps.
+ *
+ * @class
+ */
 class UniqueMapsModule {
+  /**
+   * The query URL for fetching Unique Maps data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of UniqueMapsModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching Unique Maps data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `currency${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves Unique Maps data based on the specified properties.
+   *
+   * @async
+   * @param {Array<string>} requestedProperties - An array of properties to retrieve.
+   * @returns {Promise<Object>} A promise that resolves to the retrieved data.
+   */
   async getData(requestedProperties) {
-    return getData(this.#queryUrl, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch Unique Maps data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the Unique Maps data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Unique Maps data: ${error.message}`);
+    }
   }
 }
 
+// Export the UniqueMapsModule class
 module.exports = UniqueMapsModule;

package/lib/modules/poe.watch/allModules/submodules/WeaponModule.js

@@ -1,13 +1,87 @@
 const getData = require("../functions/getData");
+const getCategory = require("../functions/getCategory");
 
+/**
+ * Represents a module for fetching data related to Weapons.
+ *
+ * @class
+ */
 class WeaponModule {
+  /**
+   * The query URL for fetching Weapon data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of WeaponModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching Weapon data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `weapon${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves Weapon data based on the specified properties.
+   *
+   * @async
+   * @param {Array<string>} requestedProperties - An array of properties to retrieve.
+   * @returns {Promise<Object>} A promise that resolves to the retrieved data.
+   */
   async getData(requestedProperties) {
-    return getData(this.#queryUrl, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch Weapon data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the Weapon data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Weapon data: ${error.message}`);
+    }
+  }
+  /**
+   * Asynchronously retrieves weapon data based on the specified category name.
+   *
+   * @async
+   * @param {string} categoryName - The name of the category to retrieve.
+   * *   Possible values: "twohandswords", "fishingrods", "onehandswords", "twohandaxes", "staves", "warstaff", "daggers", "scepters".
+   * @returns {Promise<Array<Object>>} - A promise that resolves to the retrieved data.
+   * @throws {Error} - Throws an error if there is an issue fetching or processing the weapon data for the specified category.
+   *
+   */
+  async getCategory(categoryName) {
+    try {
+      /**
+       * Calls the getCategory function to fetch weapon data based on category name.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getCategory(this.#queryUrl, categoryName);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the weapon data for the specified category.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching data Weapon Category: ${error.message}`);
+    }
   }
 }
 
+// Export the WeaponModule class
 module.exports = WeaponModule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poe-api-manager",
-  "version": "0.2.2",
+  "version": "0.2.8",
   "description": "API management for poe.ninja and poe.watch",
   "main": "index.js",
   "scripts": {