Skip to content

Documentation


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

Function: characterEquipmentSummary() ​

characterEquipmentSummary(namespace, realmSlug, characterName): object

Defined in: classic-wow/src/character-equipment/index.ts:12

Returns a summary of the items equipped by a character.

Parameters ​

namespace ​

"profile-classic1x" | "profile-classic" | "profile-classicann"

The namespace to use. See ProfileClassicNamespaces.

realmSlug ​

string

The realm slug.

characterName ​

string

The character name.

Returns ​

The character equipment summary.

_responseType? ​

optional _responseType?: CharacterEquipmentSummaryResponse

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.