Skip to content

Documentation


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

Function: realmIndex() ​

realmIndex(namespace): object

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

Get a realm index.

Parameters ​

namespace ​

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

The namespace to use. See DynamicClassicNamespaces.

Returns ​

The realm index. See RealmIndexResponse.

_responseType? ​

optional _responseType?: RealmIndexResponse

Internal

The response type of the resource

namespace? ​

optional namespace?: BlizzardNamespaces

parameters? ​

optional parameters?: Record<string, unknown>

path ​

path: string

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