@blizzard-api/classic-wow
Version:
A series of helpers to interact with the World of Warcraft Classic Blizzard API
36 lines (35 loc) • 1.41 kB
TypeScript
import { BlizzardNamespaces, Href, NameId, Resource, ResponseBase } from "@blizzard-api/core";
//#region src/region/types.d.ts
/**
* The response for a region index.
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
*/
interface RegionIndexResponse extends ResponseBase {
regions: Array<Href>;
}
/**
* The response for a region.
* @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
*/
interface RegionResponse extends NameId, ResponseBase {
patch_string: string;
tag: string;
}
//#endregion
//#region src/region/index.d.ts
/**
* Get a region by ID.
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
* @param regionId The region ID.
* @returns The region. See {@link RegionResponse}.
*/
declare function region(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, regionId: number): Resource<RegionResponse>;
/**
* Get a region index.
* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
* @returns The region index. See {@link RegionIndexResponse}.
*/
declare function regionIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>): Resource<RegionIndexResponse>;
//#endregion
export { RegionResponse as i, regionIndex as n, RegionIndexResponse as r, region as t };
//# sourceMappingURL=index-DUgdQv4k.d.ts.map