poe-api-manager 0.2.2 → 0.2.6

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

@@ -1,13 +1,59 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Armour.
+ *
+ * @class
+ */
 class ArmourModule {
+  /**
+   * The query URL for fetching armour data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of ArmourModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching armour data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `armour${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves armour 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 armour data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the armour data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching armour data: ${error.message}`);
+    }
   }
 }
 
+// Export the ArmourModule class
 module.exports = ArmourModule;

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

@@ -1,13 +1,59 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Bases.
+ *
+ * @class
+ */
 class BaseModule {
+  /**
+   * The query URL for fetching base data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of BaseModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching base data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `bases${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves base 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 base data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the base data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching base data: ${error.message}`);
+    }
   }
 }
 
+// Export the BaseModule class
 module.exports = BaseModule;

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

@@ -1,13 +1,59 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Beasts.
+ *
+ * @class
+ */
 class BeastModule {
+  /**
+   * The query URL for fetching beast data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of BeastModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching beast data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `beast${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves beast 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 beast data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the beast data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching beast data: ${error.message}`);
+    }
   }
 }
 
+// Export the BeastModule class
 module.exports = BeastModule;

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

@@ -1,13 +1,60 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Currency.
+ *
+ * @class
+ */
 class CurrencyModule {
+  /**
+   * The query URL for fetching currency data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of CurrencyModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching currency data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `currency${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves currency 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 currency data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the currency data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching currency data: ${error.message}`);
+    }
   }
 }
-// export CurrencyModule;
+
+// Uncomment the line below if you want to export the CurrencyModule class
+// module.exports = CurrencyModule;
 module.exports = CurrencyModule;

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

@@ -1,13 +1,59 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Delirium Orbs.
+ *
+ * @class
+ */
 class DeliriumOrbModule {
+  /**
+   * The query URL for fetching Delirium Orb data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of DeliriumOrbModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching Delirium Orb data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `currency${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves Delirium Orb 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 Delirium Orb data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the Delirium Orb data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Delirium Orb data: ${error.message}`);
+    }
   }
 }
 
+// Export the DeliriumOrbModule class
 module.exports = DeliriumOrbModule;

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

@@ -1,13 +1,59 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Divination Cards.
+ *
+ * @class
+ */
 class DivsModule {
+  /**
+   * The query URL for fetching Divination Card data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of DivsModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching Divination Card data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `currency${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves Divination Card 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 Divination Card data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the Divination Card data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Divination Card data: ${error.message}`);
+    }
   }
 }
 
+// Export the DivsModule class
 module.exports = DivsModule;

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

@@ -1,13 +1,59 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Essences.
+ *
+ * @class
+ */
 class EssenceModule {
+  /**
+   * The query URL for fetching Essence data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of EssenceModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching Essence data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `essence${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves Essence 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 Essence data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the Essence data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Essence data: ${error.message}`);
+    }
   }
 }
 
+// Export the EssenceModule class
 module.exports = EssenceModule;

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

@@ -1,13 +1,59 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Flasks.
+ *
+ * @class
+ */
 class FlaskModule {
+  /**
+   * The query URL for fetching Flask data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of FlaskModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching Flask data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `flask${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves Flask 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 Flask data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the Flask data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Flask data: ${error.message}`);
+    }
   }
 }
 
+// Export the FlaskModule class
 module.exports = FlaskModule;

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

@@ -1,13 +1,59 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Fossils.
+ *
+ * @class
+ */
 class FossilModule {
+  /**
+   * The query URL for fetching Fossil data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of FossilModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching Fossil data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `fossil${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves Fossil 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 Fossil data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the Fossil data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Fossil data: ${error.message}`);
+    }
   }
 }
 
+// Export the FossilModule class
 module.exports = FossilModule;

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

@@ -1,13 +1,59 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Fragments.
+ *
+ * @class
+ */
 class FragmentModule {
+  /**
+   * The query URL for fetching Fragment data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of FragmentModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching Fragment data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `fragment${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves Fragment 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 Fragment data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the Fragment data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Fragment data: ${error.message}`);
+    }
   }
 }
 
+// Export the FragmentModule class
 module.exports = FragmentModule;

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

@@ -1,13 +1,59 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Skill Gems.
+ *
+ * @class
+ */
 class GemModule {
+  /**
+   * The query URL for fetching Skill Gem data.
+   *
+   * @private
+   * @type {string}
+   */
   #queryUrl;
+
+  /**
+   * Creates an instance of GemModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * The constructed query URL for fetching Skill Gem data.
+     *
+     * @private
+     * @type {string}
+     */
     this.#queryUrl = `gem${leagueUrl}`;
   }
+
+  /**
+   * Asynchronously retrieves Skill Gem 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 Skill Gem data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#queryUrl, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the Skill Gem data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Skill Gem data: ${error.message}`);
+    }
   }
 }
 
+// Export the GemModule class
 module.exports = GemModule;