Skip to content

Documentation


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

Function: connectedRealmIndex() ​

connectedRealmIndex(namespace): object

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

Returns an index of connected realms.

Parameters ​

namespace ​

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

The namespace to use. See DynamicClassicNamespaces.

Returns ​

The connected realm index. See ConnectedRealmIndexResponse.

_responseType? ​

optional _responseType?: ConnectedRealmIndexResponse

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.