Skip to content

Documentation


Documentation / @blizzard-api/classic-wow / realmSearch

Function: realmSearch() ​

realmSearch(namespace, options): object

Defined in: classic-wow/src/realm/index.ts:34

Search for realms.

Parameters ​

namespace ​

"dynamic-classic1x" | "dynamic-classic" | "dynamic-classicann"

The namespace to use. See DynamicClassicNamespaces.

options ​

RealmSearchParameters

The search parameters. See RealmSearchParameters.

Returns ​

The search results. See RealmSearchResponse.

_responseType? ​

optional _responseType?: RealmSearchResponse

Internal

The response type of the resource

namespace? ​

optional namespace?: BlizzardNamespaces

parameters? ​

optional parameters?: RealmSearchParameters

path ​

path: string

The request path. Dynamic path segments should be encoded with encodeURIComponent.