poe-api-manager 1.2.4 → 1.2.12

package/Changelog.md

@@ -1,9 +1,16 @@
 # Changelog
-## 1.2.4
-- 🚀 [Added] Allflame Embers added to itemview.
 
-## 1.2.3
-- 🚀 [Added] Coffins added to itemview.
+## 1.2.12
+- 🚀[New] I decided to develop the main project with Typescript language. From now on, development will only continue from here.
+- 🛠️[Fix] Typescript uses.
+
+## 1.2.9
+- 🚀[Added] Allflame Embers added to itemview.
+
+## 1.2.8
+- 🚀[Added] Coffins added to itemview.
+- 🛠️[Fix] Fix default value for typescript requestedProperties.
+- 🛠️[Fix] Fix bun error.
 
 ## 1.2.2
 - 🛠️ [Fixed] Control mechanisms in API calls have been improved for better error handling.
@@ -41,4 +48,4 @@
     - Invitations
     - Memories
 
-## 0.0.1 Publish
+## 0.0.1 Publish

package/README.md

@@ -2,8 +2,8 @@
 
 [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
 ![GitHub package.json version](https://img.shields.io/github/package-json/v/ayberkgezer/poe-api-manager)
-![GitHub top language](https://img.shields.io/github/languages/top/ayberkgezer/poe-api-manager?logo=javascript)
-[![ISSUES](https://img.shields.io/github/issues/ayberkgezer/poe-api-manager)](https://github.com/ayberkgezer/poe-api-manager/issues)
+![GitHub top language](https://img.shields.io/github/languages/top/ayberkgezer/poe-api-manager?logo=typescript)
+[![ISSUES](https://img.shields.io/github/issues/ayberkgezer/poe-api-manager-ts)](https://github.com/ayberkgezer/poe-api-manager/issues)
 ![NPM Downloads](https://img.shields.io/npm/dt/poe-api-manager?logo=npm)
 
 
@@ -12,8 +12,8 @@
 - [Installation](#installation)
 - [Getting Started](#getting-started)
   - [poe.ninja](#ninjaapi)
-    - [currencyView](#currencywiev)
-    - [itemView](#itemwiev)
+    - [currencyView](#currencyview)
+    - [itemView](#itemview)
   - [poe.watch](#watchapi)
     - [view](#view)
   - [utils](#utils)
@@ -23,7 +23,7 @@
 
 
 ## Introduction
-The purpose of this library is to make the economic data in the Path of Exile game easily usable.
+The purpose of this library is to make the economic data in the Path of Exile game easily usable. This library is written in typescript.
 
 >Important!: For economy, it is taken from the poe.ninja and poe.watch
 
@@ -36,7 +36,11 @@ Permission to access two different services. poe.ninja and poe.watch
 ## Installation
 **Install with npm:**
 ```bash
-$ npm install poe-api-manager
+$ npm i poe-api-manager
+```
+**Install with bun:**
+```bash
+$ bun i poe-api-manager
 ```
 
 ## Getting Started
@@ -104,6 +108,7 @@ What we can get here is as follows.
 - Blight Ravaged Maps
 - Invitations
 - Memories
+- Coffins
 - Allflame Embers
 
 - getData() => function returns data purely.

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { NinjaAPI } from "./lib/NinjaAPI";
+import { WatchAPI } from "./lib/WatchAPI";
+import Utils from "./lib/Utils";
+export { NinjaAPI, WatchAPI, Utils, };

package/dist/index.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Utils = exports.WatchAPI = exports.NinjaAPI = void 0;
+const NinjaAPI_1 = require("./lib/NinjaAPI");
+Object.defineProperty(exports, "NinjaAPI", { enumerable: true, get: function () { return NinjaAPI_1.NinjaAPI; } });
+const WatchAPI_1 = require("./lib/WatchAPI");
+Object.defineProperty(exports, "WatchAPI", { enumerable: true, get: function () { return WatchAPI_1.WatchAPI; } });
+const Utils_1 = __importDefault(require("./lib/Utils"));
+exports.Utils = Utils_1.default;

package/dist/index.min.js

@@ -0,0 +1 @@
+"use strict";var __importDefault=this&&this.__importDefault||function(mod){return mod&&mod.__esModule?mod:{default:mod}};Object.defineProperty(exports,"__esModule",{value:true});exports.Utils=exports.WatchAPI=exports.NinjaAPI=void 0;const NinjaAPI_1=require("./lib/NinjaAPI");Object.defineProperty(exports,"NinjaAPI",{enumerable:true,get:function(){return NinjaAPI_1.NinjaAPI}});const WatchAPI_1=require("./lib/WatchAPI");Object.defineProperty(exports,"WatchAPI",{enumerable:true,get:function(){return WatchAPI_1.WatchAPI}});const Utils_1=__importDefault(require("./lib/Utils"));exports.Utils=Utils_1.default;

package/dist/lib/NinjaAPI.d.ts

@@ -0,0 +1,21 @@
+import { CurrencyViewModule } from "./modules/poe.ninja/currencyView/CurrencyViewModule";
+import { ItemViewModule } from "./modules/poe.ninja/itemView/ItemViewModule";
+/**
+ * Represents an API for interacting with the poe.ninja API.
+ */
+export declare class NinjaAPI {
+    /**
+     * The CurrencyViewModule instance for fetching currency-related data.
+     */
+    currencyView: CurrencyViewModule;
+    /**
+     * The ItemViewModule instance for fetching item-related data.
+     *
+     */
+    itemView: ItemViewModule;
+    /**
+     * Creates an instance of NinjaAPI.
+     * @param league The PoE league for which data is requested.
+     */
+    constructor(league: string);
+}

package/dist/lib/NinjaAPI.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NinjaAPI = void 0;
+const CurrencyViewModule_1 = require("./modules/poe.ninja/currencyView/CurrencyViewModule");
+const ItemViewModule_1 = require("./modules/poe.ninja/itemView/ItemViewModule");
+/**
+ * Represents an API for interacting with the poe.ninja API.
+ */
+class NinjaAPI {
+    /**
+     * The CurrencyViewModule instance for fetching currency-related data.
+     */
+    currencyView;
+    /**
+     * The ItemViewModule instance for fetching item-related data.
+     *
+     */
+    itemView;
+    /**
+     * Creates an instance of NinjaAPI.
+     * @param league The PoE league for which data is requested.
+     */
+    constructor(league) {
+        this.currencyView = new CurrencyViewModule_1.CurrencyViewModule(league, "currencyoverview");
+        this.itemView = new ItemViewModule_1.ItemViewModule(league, "itemoverview");
+    }
+}
+exports.NinjaAPI = NinjaAPI;

package/dist/lib/Utils.d.ts

@@ -0,0 +1,21 @@
+/**
+ * A utility class.
+ */
+declare class Utils {
+    constructor();
+    /**
+     * Fetches the list of leagues for the game.
+     * @returns The array of league names.
+     * @throws If there's an error fetching the leagues.
+     */
+    getLeagues(): Promise<string[]>;
+    /**
+     * Filters properties of objects in an array based on the specified properties.
+     *
+     * @param data - The array of objects to filter.
+     * @param properties - The array of property names to include in the result.
+     * @returns - An array of objects with only the specified properties.
+     */
+    filterProperties(data: object[], properties: string[]): Promise<object[]>;
+}
+export default Utils;

package/dist/lib/Utils.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getLeagues_1 = __importDefault(require("./modules/utils/getLeagues"));
+const propertyFilter_1 = __importDefault(require("./modules/mainfunctions/propertyFilter"));
+/**
+ * A utility class.
+ */
+class Utils {
+    constructor() { }
+    /**
+     * Fetches the list of leagues for the game.
+     * @returns The array of league names.
+     * @throws If there's an error fetching the leagues.
+     */
+    async getLeagues() {
+        try {
+            return await (0, getLeagues_1.default)();
+        }
+        catch (error) {
+            throw new Error(`Error fetching data Leagues: ${error.message}`);
+        }
+    }
+    /**
+     * Filters properties of objects in an array based on the specified properties.
+     *
+     * @param data - The array of objects to filter.
+     * @param properties - The array of property names to include in the result.
+     * @returns - An array of objects with only the specified properties.
+     */
+    async filterProperties(data, properties) {
+        try {
+            return (0, propertyFilter_1.default)(data, properties);
+        }
+        catch (error) {
+            throw new Error(`Error fetching data Leagues: ${error.message}`);
+        }
+    }
+}
+exports.default = Utils;

package/dist/lib/WatchAPI.d.ts

@@ -0,0 +1,15 @@
+import WatchWievModule from "./modules/poe.watch/WatchViewModule";
+/**
+ * Represents an API for interacting with a poe.watch service.
+ */
+export declare class WatchAPI {
+    /**
+     * The WatchWievModule instance associated with this API.
+     */
+    view: WatchWievModule;
+    /**
+     * Creates an instance of WatchAPI.
+     * @param league - The league for which the API should be initialized.
+     */
+    constructor(league: string);
+}

package/dist/lib/WatchAPI.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WatchAPI = void 0;
+const WatchViewModule_1 = __importDefault(require("./modules/poe.watch/WatchViewModule"));
+/**
+ * Represents an API for interacting with a poe.watch service.
+ */
+class WatchAPI {
+    /**
+     * The WatchWievModule instance associated with this API.
+     */
+    view;
+    /**
+     * Creates an instance of WatchAPI.
+     * @param league - The league for which the API should be initialized.
+     */
+    constructor(league) {
+        this.view = new WatchViewModule_1.default(league);
+    }
+}
+exports.WatchAPI = WatchAPI;

package/dist/lib/modules/AbstractClass/PoeNinja.d.ts

@@ -0,0 +1,28 @@
+import IPoeNinja from "../Interfaces/IPoeNinja";
+/**
+ * Abstract class representing a PoeNinja.
+ * @abstract
+ * @class
+ * @implements {IPoeNinja}
+ */
+declare abstract class PoeNinja implements IPoeNinja {
+    protected readonly league: string;
+    protected readonly typeName: string;
+    protected readonly type: string;
+    /**
+     * Represents a PoeNinja object.
+     * @constructor
+     * @param league - The league name.
+     * @param typeName
+     * @param type - The type.
+     */
+    constructor(league: string, typeName: string, type: string);
+    /**
+     * Retrieves data from the API based on the specified league, type name, and type.
+     * @param requestedProperties - Optional array of properties to include in the retrieved data.
+     * @returns A promise that resolves to an array of objects containing the retrieved data.
+     * @throws If there is an error retrieving the data.
+     */
+    getData(requestedProperties?: string[]): Promise<object[]>;
+}
+export default PoeNinja;

package/dist/lib/modules/AbstractClass/PoeNinja.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getData_1 = __importDefault(require("../poe.ninja/func/getData"));
+/**
+ * Abstract class representing a PoeNinja.
+ * @abstract
+ * @class
+ * @implements {IPoeNinja}
+ */
+class PoeNinja {
+    league;
+    typeName;
+    type;
+    /**
+     * Represents a PoeNinja object.
+     * @constructor
+     * @param league - The league name.
+     * @param typeName
+     * @param type - The type.
+     */
+    constructor(league, typeName, type) {
+        this.league = league;
+        this.typeName = typeName;
+        this.type = type;
+    }
+    /**
+     * Retrieves data from the API based on the specified league, type name, and type.
+     * @param requestedProperties - Optional array of properties to include in the retrieved data.
+     * @returns A promise that resolves to an array of objects containing the retrieved data.
+     * @throws If there is an error retrieving the data.
+     */
+    async getData(requestedProperties) {
+        try {
+            return (0, getData_1.default)(this.league, this.typeName, this.type, requestedProperties);
+        }
+        catch (error) {
+            throw new Error(`Error getData ${this.typeName} and ${this.type} data: ${error.message}`);
+        }
+    }
+}
+exports.default = PoeNinja;

package/dist/lib/modules/AbstractClass/PoeWatch.d.ts

@@ -0,0 +1,17 @@
+import IPoeWatch from "../Interfaces/IPoeWatch";
+/**
+ * Represents an abstract class for interacting with the PoeWatch API.
+ */
+declare abstract class PoeWatch implements IPoeWatch {
+    protected readonly league: string;
+    protected readonly type: string;
+    constructor(league: string, type: string);
+    /**
+     * Retrieves data from the PoeWatch API.
+     * @param requestedProperties Optional array of properties to include in the response.
+     * @returns A promise that resolves to an array of objects containing the requested data.
+     * @throws If there is an error retrieving the data.
+     */
+    getData(requestedProperties?: string[]): Promise<object[]>;
+}
+export default PoeWatch;

package/dist/lib/modules/AbstractClass/PoeWatch.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getData_1 = __importDefault(require("../poe.watch/allModules/func/getData"));
+/**
+ * Represents an abstract class for interacting with the PoeWatch API.
+ */
+class PoeWatch {
+    league;
+    type;
+    constructor(league, type) {
+        this.league = league;
+        this.type = type;
+    }
+    /**
+     * Retrieves data from the PoeWatch API.
+     * @param requestedProperties Optional array of properties to include in the response.
+     * @returns A promise that resolves to an array of objects containing the requested data.
+     * @throws If there is an error retrieving the data.
+     */
+    async getData(requestedProperties) {
+        try {
+            return (0, getData_1.default)(this.league, this.type, requestedProperties);
+        }
+        catch (error) {
+            throw new Error(`Error retrieving ${this.type} data: ${error.message}`);
+        }
+    }
+}
+exports.default = PoeWatch;

package/dist/lib/modules/Interfaces/IPoeNinja.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Represents the interface for interacting with the PoeNinja API.
+ */
+interface IPoeNinja {
+    /**
+     * Retrieves data from the PoeNinja API.
+     * @param requestedProperties Optional array of properties to include in the response.
+     * @returns A promise that resolves to the retrieved data.
+     */
+    getData(requestedProperties?: string[]): Promise<object[]>;
+}
+export default IPoeNinja;

package/dist/lib/modules/Interfaces/IPoeNinja.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/modules/Interfaces/IPoeWatch.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Represents the interface for interacting with PoeWatch data.
+ */
+interface IPoeWatch {
+    /**
+     * Retrieves data from PoeWatch API.
+     * @param requestedProperties Optional array of properties to include in the response.
+     * @returns A promise that resolves to an array of objects representing the retrieved data.
+     */
+    getData(requestedProperties?: string[]): Promise<object[]>;
+}
+export default IPoeWatch;

package/dist/lib/modules/Interfaces/IPoeWatch.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/modules/mainfunctions/propertyFilter.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Filters properties of objects in an array based on the specified properties.
+ * @param data The array of objects to filter.
+ * @param requestedProperties The array of property names to include in the result.
+ * @returns An array of objects with only the specified properties.
+ */
+export default function filterProperties(data: Record<string, any>[], requestedProperties: string[]): object[];

package/dist/lib/modules/mainfunctions/propertyFilter.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Filters properties of objects in an array based on the specified properties.
+ * @param data The array of objects to filter.
+ * @param requestedProperties The array of property names to include in the result.
+ * @returns An array of objects with only the specified properties.
+ */
+function filterProperties(data, requestedProperties) {
+    const result = [];
+    data.forEach((item) => {
+        const itemResult = {};
+        requestedProperties.forEach((prop) => {
+            if (Object.prototype.hasOwnProperty.call(item, prop)) {
+                itemResult[prop] = item[prop];
+            }
+            else {
+                console.warn(`Property not found: ${prop}`);
+            }
+        });
+        result.push(itemResult);
+    });
+    return result;
+}
+exports.default = filterProperties;

package/dist/lib/modules/poe.ninja/currencyView/CurrencyViewModule.d.ts

@@ -0,0 +1,20 @@
+import { CurrencyModule, FragmentModule } from "./currencySubModules/CurrencySubModules";
+/**
+ * Represents a module for fetching currency overview data.
+ */
+export declare class CurrencyViewModule {
+    /**
+     * Represents a module for fetching currency data.
+     */
+    currency: CurrencyModule;
+    /**
+     * Represents a module for fetching fragment data.
+     */
+    fragment: FragmentModule;
+    /**
+     * Creates a new CurrencyViewModule instance.
+     * @param league The name of the Path of Exile league.
+     * @param typeName The type of data to retrieve.
+     */
+    constructor(league: string, typeName: string);
+}

package/dist/lib/modules/poe.ninja/currencyView/CurrencyViewModule.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CurrencyViewModule = void 0;
+const CurrencySubModules_1 = require("./currencySubModules/CurrencySubModules");
+/**
+ * Represents a module for fetching currency overview data.
+ */
+class CurrencyViewModule {
+    /**
+     * Represents a module for fetching currency data.
+     */
+    currency;
+    /**
+     * Represents a module for fetching fragment data.
+     */
+    fragment;
+    /**
+     * Creates a new CurrencyViewModule instance.
+     * @param league The name of the Path of Exile league.
+     * @param typeName The type of data to retrieve.
+     */
+    constructor(league, typeName) {
+        this.currency = new CurrencySubModules_1.CurrencyModule(league, typeName);
+        this.fragment = new CurrencySubModules_1.FragmentModule(league, typeName);
+    }
+}
+exports.CurrencyViewModule = CurrencyViewModule;

package/dist/lib/modules/poe.ninja/currencyView/currencySubModules/CurrencySubModules.d.ts

@@ -0,0 +1,3 @@
+import CurrencyModule from "./submodules/CurrencyModule";
+import FragmentModule from "./submodules/FragmentModule";
+export { CurrencyModule, FragmentModule, };

package/dist/lib/modules/poe.ninja/currencyView/currencySubModules/CurrencySubModules.js

@@ -0,0 +1,10 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FragmentModule = exports.CurrencyModule = void 0;
+const CurrencyModule_1 = __importDefault(require("./submodules/CurrencyModule"));
+exports.CurrencyModule = CurrencyModule_1.default;
+const FragmentModule_1 = __importDefault(require("./submodules/FragmentModule"));
+exports.FragmentModule = FragmentModule_1.default;

package/dist/lib/modules/poe.ninja/currencyView/currencySubModules/submodules/CurrencyModule.d.ts

@@ -0,0 +1,25 @@
+import PoeNinja from "../../../../AbstractClass/PoeNinja";
+/**
+ * Represents a module for retrieving currency data from the PoeNinja API.
+ */
+declare class CurrencyModule extends PoeNinja {
+    protected league: string;
+    protected typeName: string;
+    /**
+     * Creates an instance of CurrencyModule.
+     * @param league - The name of the league.
+     * @param typeName - The name of the type.
+     */
+    constructor(league: string, typeName: string);
+    /**
+     * Retrieves the quick currency data for the specified currency type.
+     * @param currencyTypeName - The name of the currency. Defaults to "Divine Orb".
+     * @returns A promise that resolves to an object containing the currency type name and its chaos equivalent value.
+     * @throws If there is an error fetching the quick currency data.
+     */
+    getQuickCurrency(currencyTypeName?: string): Promise<{
+        currencyTypeName: string;
+        chaosEquivalent: number;
+    }>;
+}
+export default CurrencyModule;

package/dist/lib/modules/poe.ninja/currencyView/currencySubModules/submodules/CurrencyModule.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const PoeNinja_1 = __importDefault(require("../../../../AbstractClass/PoeNinja"));
+const getQuickCurrency_1 = __importDefault(require("../../../func/getQuickCurrency"));
+/**
+ * Represents a module for retrieving currency data from the PoeNinja API.
+ */
+class CurrencyModule extends PoeNinja_1.default {
+    league;
+    typeName;
+    /**
+     * Creates an instance of CurrencyModule.
+     * @param league - The name of the league.
+     * @param typeName - The name of the type.
+     */
+    constructor(league, typeName) {
+        const type = "Currency";
+        super(league, typeName, type);
+        this.league = league;
+        this.typeName = typeName;
+    }
+    /**
+     * Retrieves the quick currency data for the specified currency type.
+     * @param currencyTypeName - The name of the currency. Defaults to "Divine Orb".
+     * @returns A promise that resolves to an object containing the currency type name and its chaos equivalent value.
+     * @throws If there is an error fetching the quick currency data.
+     */
+    async getQuickCurrency(currencyTypeName = "Divine Orb") {
+        try {
+            return await (0, getQuickCurrency_1.default)(this.league, this.typeName, this.type, currencyTypeName);
+        }
+        catch (error) {
+            throw new Error(`Error fetching QuickCurrencyData ${this.type} and Currency Name:${currencyTypeName} data: ${error.message}`);
+        }
+    }
+}
+exports.default = CurrencyModule;

package/dist/lib/modules/poe.ninja/currencyView/currencySubModules/submodules/FragmentModule.d.ts

@@ -0,0 +1,15 @@
+import PoeNinja from "../../../../AbstractClass/PoeNinja";
+/**
+ * Represents a module for handling fragments in the PoeNinja currency view.
+ */
+declare class FragmentModule extends PoeNinja {
+    protected league: string;
+    protected typeName: string;
+    /**
+     * Creates an instance of FragmentModule.
+     * @param league The league for which the module is created.
+     * @param typeName The type name of the module.
+     */
+    constructor(league: string, typeName: string);
+}
+export default FragmentModule;

package/dist/lib/modules/poe.ninja/currencyView/currencySubModules/submodules/FragmentModule.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const PoeNinja_1 = __importDefault(require("../../../../AbstractClass/PoeNinja"));
+/**
+ * Represents a module for handling fragments in the PoeNinja currency view.
+ */
+class FragmentModule extends PoeNinja_1.default {
+    league;
+    typeName;
+    /**
+     * Creates an instance of FragmentModule.
+     * @param league The league for which the module is created.
+     * @param typeName The type name of the module.
+     */
+    constructor(league, typeName) {
+        const type = "Fragment";
+        super(league, typeName, type);
+        this.league = league;
+        this.typeName = typeName;
+    }
+}
+exports.default = FragmentModule;

package/dist/lib/modules/poe.ninja/fetch/fetchData.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Fetches data from a specified API endpoint, merges relevant data, and returns the result.
+ * @param league The game league for which to fetch data.
+ * @param type The type of data to fetch. (e.g. "Currency", "Fragment")
+ * @param typeName The name of the type of data to fetch. (e.g. "CurrencyOverview", "ItemOverview")
+ * @returns A promise that resolves to an array of merged objects containing both line and currency details.
+ * @throws Throws an error if there's an issue with the API response or data fetching process.
+ */
+declare function fetchData(league: string, typeName: string, type: string): Promise<object[]>;
+export default fetchData;