@blizzard-api/classic-wow
Version:
A series of helpers to interact with the World of Warcraft Classic Blizzard API
37 lines (36 loc) • 1.57 kB
TypeScript
import { BaseSearchParameters, BlizzardNamespaces, KeyBase, MediaAsset, Resource, SearchResponseWithoutResults } from "@blizzard-api/core";
//#region src/media-search/types.d.ts
/**
* The search parameters for media.
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
*/
interface MediaSearchParameters extends BaseSearchParameters {
tags?: string;
}
/**
* The response for a media search.
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
*/
interface MediaSearchResponse extends SearchResponseWithoutResults {
results: Array<MediaSearchResponseItem>;
}
interface MediaSearchResponseItem extends KeyBase {
data: {
assets?: Array<MediaAsset>;
id?: number;
};
}
//#endregion
//#region src/media-search/index.d.ts
/**
* Search for media.
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
* @param options The search parameters. See {@link MediaSearchParameters}.
* @returns The search results. See {@link MediaSearchResponse}.
*/
declare function mediaSearch(namespace: Extract<BlizzardNamespaces, 'static-classic1x' | 'static-classic'>, options: MediaSearchParameters): Resource<MediaSearchResponse, MediaSearchParameters>;
//#endregion
export { MediaSearchParameters as n, MediaSearchResponse as r, mediaSearch as t };
//# sourceMappingURL=index-Ce02MoQO.d.ts.map