Skip to content

Documentation


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

Function: characterProfileSummary() ​

characterProfileSummary(namespace, realmSlug, characterName): object

Defined in: classic-wow/src/character-profile/index.ts:40

Returns a summary of the character profile for a character.

Parameters ​

namespace ​

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

The namespace to use. See ProfileClassicNamespaces.

realmSlug ​

string

The slug of the realm.

characterName ​

string

The lowercase name of the character.

Returns ​

a summary of the character profile for a character.

_responseType? ​

optional _responseType?: CharacterProfileSummaryResponse

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.