@blizzard-api/classic-wow/dist/realm/index.d.ts

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

import { a as RealmSearchParameters, i as RealmResponse, n as RealmIndexResponse, o as RealmSearchResponse } from "../types-gA98D5Xw.js";
import { BlizzardNamespaces, Resource } from "@blizzard-api/core";

//#region src/realm/index.d.ts
/**
 * Get a realm by slug.
 * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
 * @param realmSlug The realm slug.
 * @returns The realm. See {@link RealmResponse}.
 */
declare function realm(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, realmSlug: string): Resource<RealmResponse>;
/**
 * Get a realm index.
 * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
 * @returns The realm index. See {@link RealmIndexResponse}.
 */
declare function realmIndex(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>): Resource<RealmIndexResponse>;
/**
 * Search for realms.
 * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
 * @param options The search parameters. See {@link RealmSearchParameters}.
 * @returns The search results. See {@link RealmSearchResponse}.
 */
declare function realmSearch(namespace: Extract<BlizzardNamespaces, 'dynamic-classic1x' | 'dynamic-classic'>, options: RealmSearchParameters): Resource<RealmSearchResponse, RealmSearchParameters>;
//#endregion
export { realm, realmIndex, realmSearch };
//# sourceMappingURL=index.d.ts.map