poe-api-manager 0.2.2 → 0.2.8

package/lib/modules/poe.ninja/item/itemSubmodules/subModules/SkillGemModule.js

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Skill Gems.
+ *
+ * @class
+ */
 class SkillGemModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (SkillGem in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of SkillGemModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "SkillGem";
   }
 
+  /**
+   * Asynchronously retrieves 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.#url, this.#type, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch SkillGem data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#url, this.#type, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the SkillGem data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching SkillGem data: ${error.message}`);
+    }
   }
 }
 
-//export SkillGemModule;
 module.exports = SkillGemModule;

package/lib/modules/poe.ninja/item/itemSubmodules/subModules/UniqueAccessoryModule.js

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Unique Accessories.
+ *
+ * @class
+ */
 class UniqueAccessoryModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (UniqueAccessory in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of UniqueAccessoryModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "UniqueAccessory";
   }
 
+  /**
+   * Asynchronously retrieves 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.#url, this.#type, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch UniqueAccessory data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#url, this.#type, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the UniqueAccessory data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching UniqueAccessory data: ${error.message}`);
+    }
   }
 }
 
-//export UniqueAccessoryModule;
 module.exports = UniqueAccessoryModule;

package/lib/modules/poe.ninja/item/itemSubmodules/subModules/UniqueArmourModule.js

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Unique Armours.
+ *
+ * @class
+ */
 class UniqueArmourModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (UniqueArmour in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of UniqueArmourModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "UniqueArmour";
   }
 
+  /**
+   * Asynchronously retrieves 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.#url, this.#type, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch UniqueArmour data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#url, this.#type, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the UniqueArmour data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching UniqueArmour data: ${error.message}`);
+    }
   }
 }
 
-//export UniqueArmourModule;
 module.exports = UniqueArmourModule;

package/lib/modules/poe.ninja/item/itemSubmodules/subModules/UniqueFlaskModule.js

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Unique Flasks.
+ *
+ * @class
+ */
 class UniqueFlaskModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (UniqueFlask in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of UniqueFlaskModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "UniqueFlask";
   }
 
+  /**
+   * Asynchronously retrieves 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.#url, this.#type, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch UniqueFlask data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#url, this.#type, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the UniqueFlask data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching UniqueFlask data: ${error.message}`);
+    }
   }
 }
 
-//export UniqueMapModule;
 module.exports = UniqueFlaskModule;

package/lib/modules/poe.ninja/item/itemSubmodules/subModules/UniqueJewelModule.js

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Unique Jewels.
+ *
+ * @class
+ */
 class UniqueJewelModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (UniqueJewel in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of UniqueJewelModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "UniqueJewel";
   }
 
+  /**
+   * Asynchronously retrieves 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.#url, this.#type, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch UniqueJewel data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#url, this.#type, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the UniqueJewel data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching UniqueJewel data: ${error.message}`);
+    }
   }
 }
 
-//export UniqueJewelModule;
 module.exports = UniqueJewelModule;

package/lib/modules/poe.ninja/item/itemSubmodules/subModules/UniqueMapModule.js

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Unique Maps.
+ *
+ * @class
+ */
 class UniqueMapModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (UniqueMap in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of UniqueMapModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "UniqueMap";
   }
 
+  /**
+   * Asynchronously retrieves 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.#url, this.#type, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch UniqueMap data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#url, this.#type, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the UniqueMap data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching UniqueMap data: ${error.message}`);
+    }
   }
 }
 
-//export UniqueMapModule;
 module.exports = UniqueMapModule;

package/lib/modules/poe.ninja/item/itemSubmodules/subModules/UniqueRelicModule.js

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Unique Relics.
+ *
+ * @class
+ */
 class UniqueRelicModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (UniqueRelic in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of UniqueRelicModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "UniqueRelic";
   }
 
+  /**
+   * Asynchronously retrieves 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.#url, this.#type, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch UniqueRelic data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#url, this.#type, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the UniqueRelic data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching UniqueRelic data: ${error.message}`);
+    }
   }
 }
 
-//export UniqueRelicModule;
 module.exports = UniqueRelicModule;

package/lib/modules/poe.ninja/item/itemSubmodules/subModules/UniqueWeaponModule.js

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Unique Weapons.
+ *
+ * @class
+ */
 class UniqueWeaponModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (UniqueWeapon in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of UniqueWeaponModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "UniqueWeapon";
   }
 
+  /**
+   * Asynchronously retrieves 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.#url, this.#type, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch UniqueWeapon data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#url, this.#type, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the UniqueWeapon data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching UniqueWeapon data: ${error.message}`);
+    }
   }
 }
 
-//export UniqueWeaponModule;
 module.exports = UniqueWeaponModule;

package/lib/modules/poe.ninja/item/itemSubmodules/subModules/VialsModule.js

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Vials.
+ *
+ * @class
+ */
 class VialsModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (Vial in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of VialsModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "Vial";
   }
 
+  /**
+   * Asynchronously retrieves 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.#url, this.#type, requestedProperties);
+    try {
+      /**
+       * Calls the getData function to fetch Vial data.
+       *
+       * @type {Promise<Array<Object>>}
+       */
+      return getData(this.#url, this.#type, requestedProperties);
+    } catch (error) {
+      /**
+       * Throws an error if there's an issue fetching or processing the Vial data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Vial data: ${error.message}`);
+    }
   }
 }
 
-//export VialsModule;
 module.exports = VialsModule;

package/lib/modules/poe.watch/WatchWievModule.js

@@ -1,28 +1,130 @@
 const allModules = require("./allModules/Modules");
 
+/**
+ * Represents a module for fetching data related to Watchstones and Watchstone Regions.
+ *
+ * @class
+ */
 class WatchWievModule {
+  /**
+   * Creates an instance of WatchWievModule.
+   *
+   * @param {string} leagueUrl - The league URL to fetch data from.
+   */
   constructor(leagueUrl) {
+    /**
+     * Module for fetching data related to Currency.
+     *
+     */
     this.currency = new allModules.CurrencyModule(leagueUrl);
-    //this.deliriumOrb = new allModules.DeliriumOrbModule(leagueUrl);
-    //this.divinationCard = new allModules.DivsModule(leagueUrl);
+
+    // Uncomment the lines below if you want to use and document other modules
+    // this.deliriumOrb = new allModules.DeliriumOrbModule(leagueUrl);
+    // this.divinationCard = new allModules.DivsModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Essences.
+     *
+     */
     this.essence = new allModules.EssenceModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Fossils.
+     *
+     */
     this.fossil = new allModules.FossilModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Fragments.
+     *
+     */
     this.fragment = new allModules.FragmentModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Gems.
+     *
+     */
     this.gem = new allModules.GemModule(leagueUrl);
-    //this.inscribed = new allModules.InscribedModule(leagueUrl);
+
+    // Uncomment the lines
+    // this.inscribed = new allModules.InscribedModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Invitations.
+     *
+     */
     this.invitation = new allModules.InvitationModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Jewels.
+     *
+     */
     this.jewel = new allModules.JewelModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Maps.
+     *
+     */
     this.map = new allModules.MapModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Oils.
+     *
+     */
     this.oil = new allModules.OilModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Scarabs.
+     *
+     */
     this.scarab = new allModules.ScarabModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Sextants.
+     *
+     */
     this.sextant = new allModules.SextantModule(leagueUrl);
-    //this.uniqueMap = new allModules.UniqueMapsModule(leagueUrl);
+
+    // Uncomment the lines below if you want to use and document other modules
+    // this.uniqueMap = new allModules.UniqueMapsModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Accessories.
+     *
+     */
     this.accessory = new allModules.AccessoryModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Armours.
+     *
+     */
     this.armour = new allModules.ArmourModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Weapons.
+     *
+     */
     this.weapon = new allModules.WeaponModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Flasks.
+     *
+     */
     this.flask = new allModules.FlaskModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Bases.
+     *
+     */
     this.base = new allModules.BaseModule(leagueUrl);
+
+    /**
+     * Module for fetching data related to Beasts.
+     *
+     */
     this.beast = new allModules.BeastModule(leagueUrl);
   }
 }
+
+// Export the WatchWievModule class
 module.exports = WatchWievModule;