Skip to content

Documentation


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

Function: characterHunterPetsSummary() ​

characterHunterPetsSummary(namespace, realmSlug, characterName): object

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

If the character is a hunter, returns a summary of the character's hunter pets. Otherwise, returns an HTTP 404 Not Found error.

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's hunter pets.

_responseType? ​

optional _responseType?: CharacterHunterPetsSummaryResponse

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.