@blizzard-api/wow/dist/item/index.js

A series of helpers to interact with the World of Warcraft Blizzard API

import { wowBasePath, wowMediaBasePath, wowSearchBasePath } from "@blizzard-api/core";
//#region src/item/index.ts
/**
* Get an item by ID.
* @param itemId The item ID.
* @returns The item. See {@link ItemResponse}.
*/
function item(itemId) {
	return {
		namespace: "static",
		path: `${wowBasePath}/item/${itemId}`
	};
}
/**
* Get an item class by ID.
* @param itemClassId The item class ID.
* @returns The item class. See {@link ItemClassResponse}.
*/
function itemClass(itemClassId) {
	return {
		namespace: "static",
		path: `${wowBasePath}/item-class/${itemClassId}`
	};
}
/**
* Get an item class index.
* @returns The item class index. See {@link ItemClassIndexResponse}.
*/
function itemClassIndex() {
	return {
		namespace: "static",
		path: `${wowBasePath}/item-class/index`
	};
}
/**
* Get item media by ID.
* @param itemId The item ID.
* @returns The item media. See {@link ItemMediaResponse}.
*/
function itemMedia(itemId) {
	return {
		namespace: "static",
		path: `${wowMediaBasePath}/item/${itemId}`
	};
}
/**
* Search for items.
* @param options The search parameters. See {@link ItemSearchParameters}.
* @returns The search results. See {@link ItemSearchResponse}.
*/
function itemSearch(options) {
	return {
		namespace: "static",
		parameters: {
			_page: options._page,
			[`name.${options.locale}`]: options.name,
			orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
		},
		path: `${wowSearchBasePath}/item`
	};
}
/**
* Get an item set by ID.
* @param itemSetId The item set ID.
* @returns The item set. See {@link ItemSetResponse}.
*/
function itemSet(itemSetId) {
	return {
		namespace: "static",
		path: `${wowBasePath}/item-set/${itemSetId}`
	};
}
/**
* Get an item set index.
* @returns The item set index. See {@link ItemSetIndexResponse}.
*/
function itemSetIndex() {
	return {
		namespace: "static",
		path: `${wowBasePath}/item-set/index`
	};
}
/**
* Get an item subclass by ID.
* @param itemClassId The item class ID.
* @param itemSubclassId The item subclass ID.
* @returns The item subclass. See {@link ItemSubclassResponse}.
*/
function itemSubclass(itemClassId, itemSubclassId) {
	return {
		namespace: "static",
		path: `${wowBasePath}/item-class/${itemClassId}/item-subclass/${itemSubclassId}`
	};
}
//#endregion
export { item, itemClass, itemClassIndex, itemMedia, itemSearch, itemSet, itemSetIndex, itemSubclass };

//# sourceMappingURL=index.js.map