Skip to content

Documentation


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

Function: journalEncounterSearch() ​

journalEncounterSearch(options): object

Defined in: wow-forever/src/journal/index.ts:41

Search for journal encounters.

Parameters ​

options ​

JournalEncounterSearchParameters

The search parameters. See JournalEncounterSearchParameters.

Returns ​

The search results. See JournalEncounterSearchResponse.

_responseType? ​

optional _responseType?: JournalEncounterSearchResponse

Internal

The response type of the resource

namespace? ​

optional namespace?: BlizzardNamespaces

parameters? ​

optional parameters?: Omit<JournalEncounterSearchParameters, "locale" | "instanceName">

path ​

path: string

The request path. Dynamic path segments should be encoded with encodeURIComponent.