poe-api-manager 0.2.2 → 0.2.8

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

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Essences.
+ *
+ * @class
+ */
 class EssenceModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (Essence in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of EssenceModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "Essence";
   }
 
+  /**
+   * 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 Essence 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 Essence data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Essence data: ${error.message}`);
+    }
   }
 }
 
-//export EssenceModule;
 module.exports = EssenceModule;

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

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Fossils.
+ *
+ * @class
+ */
 class FossilModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (Fossil in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of FossilModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "Fossil";
   }
 
+  /**
+   * 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 Fossil 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 Fossil data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Fossil data: ${error.message}`);
+    }
   }
 }
 
-//export FossilModule;
 module.exports = FossilModule;

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

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Helmet Enchants.
+ *
+ * @class
+ */
 class HelmetEnchantModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (HelmetEnchant in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of HelmetEnchantModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "HelmetEnchant";
   }
 
+  /**
+   * 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 HelmetEnchant 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 HelmetEnchant data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching HelmetEnchant data: ${error.message}`);
+    }
   }
 }
 
-//export HelmetEnchantModule;
 module.exports = HelmetEnchantModule;

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

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Incubators.
+ *
+ * @class
+ */
 class IncubatorModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (Incubator in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of IncubatorModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "Incubator";
   }
 
+  /**
+   * 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 Incubator 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 Incubator data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Incubator data: ${error.message}`);
+    }
   }
 }
 
-//export IncubatorModule;
 module.exports = IncubatorModule;

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

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Invitations.
+ *
+ * @class
+ */
 class InvitationModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (Invitation in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of InvitationModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "Invitation";
   }
 
+  /**
+   * 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 Invitation 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 Invitation data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Invitation data: ${error.message}`);
+    }
   }
 }
 
-//export InvitationModule;
 module.exports = InvitationModule;

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

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Maps.
+ *
+ * @class
+ */
 class MapModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (Map in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of MapModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "Map";
   }
 
+  /**
+   * 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 Map 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 Map data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Map data: ${error.message}`);
+    }
   }
 }
 
-//export MapModule;
 module.exports = MapModule;

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

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Memories.
+ *
+ * @class
+ */
 class MemoryModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (Memory in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of MemoryModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "Memory";
   }
 
+  /**
+   * 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 Memory 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 Memory data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Memory data: ${error.message}`);
+    }
   }
 }
 
-//export MemoryModule;
 module.exports = MemoryModule;

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

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Oils.
+ *
+ * @class
+ */
 class OilModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (Oil in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of OilModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "Oil";
   }
 
+  /**
+   * 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 Oil 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 Oil data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Oil data: ${error.message}`);
+    }
   }
 }
 
-//export OilModule;
 module.exports = OilModule;

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

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Omens.
+ *
+ * @class
+ */
 class OmenModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (Omen in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of OmenModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "Omen";
   }
 
+  /**
+   * 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 Omen 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 Omen data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Omen data: ${error.message}`);
+    }
   }
 }
 
-//export OmenModule;
 module.exports = OmenModule;

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

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Resonators.
+ *
+ * @class
+ */
 class ResonatorModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (Resonator in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of ResonatorModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "Resonator";
   }
 
+  /**
+   * 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 Resonator 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 Resonator data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Resonator data: ${error.message}`);
+    }
   }
 }
 
-//export ResonatorModule;
 module.exports = ResonatorModule;

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

@@ -1,17 +1,61 @@
 const getData = require("../functions/getData");
 
+/**
+ * Represents a module for fetching data related to Scarabs.
+ *
+ * @class
+ */
 class ScarabModule {
+  /**
+   * The URL for fetching data.
+   *
+   * @private
+   * @type {string}
+   */
   #url;
+
+  /**
+   * The type of data (Scarab in this case).
+   *
+   * @private
+   * @type {string}
+   */
   #type;
+
+  /**
+   * Creates an instance of ScarabModule.
+   *
+   * @param {string} url - The URL to fetch data from.
+   */
   constructor(url) {
     this.#url = url;
     this.#type = "Scarab";
   }
 
+  /**
+   * 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 Scarab 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 Scarab data.
+       *
+       * @throws {Error}
+       */
+      throw new Error(`Error fetching Scarab data: ${error.message}`);
+    }
   }
 }
 
-//export ScarabModule;
 module.exports = ScarabModule;