Skip to content

Documentation


Documentation / @blizzard-api/wow / characterHeirloomsCollectionSummary

Function: characterHeirloomsCollectionSummary() ​

characterHeirloomsCollectionSummary(realmSlug, characterName): object

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

Parameters ​

realmSlug ​

string

The slug of the realm.

characterName ​

string

The lowercase name of the character.

Returns ​

a summary of the heirlooms a character has obtained.

_responseType? ​

optional _responseType?: CharacterHeirloomsCollectionSummaryResponse

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.