Skip to content

Documentation


Documentation / @blizzard-api/wow-forever / characterCollectionsIndex

Function: characterCollectionsIndex() ​

characterCollectionsIndex(name, surname): object

Defined in: wow-forever/src/character-collections/index.ts:18

Get an index of collection types for a character.

Parameters ​

name ​

string

The character's first name.

surname ​

string

The character's surname.

Returns ​

The character's collection index. See CharacterCollectionsIndexResponse.

_responseType? ​

optional _responseType?: CharacterCollectionsIndexResponse

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.