Skip to content

Documentation


Documentation / @blizzard-api/wow / roomSearch

Function: roomSearch() ​

roomSearch(options): object

Defined in: wow/src/housing-decor/index.ts:174

Searches for rooms.

Parameters ​

options ​

GenericDecorSearchParameters

The search parameters. See GenericDecorSearchParameters.

Returns ​

A room. See RoomSearchResponse.

_responseType? ​

optional _responseType?: RoomSearchResponse

Internal

The response type of the resource

namespace? ​

optional namespace?: BlizzardNamespaces

parameters? ​

optional parameters?: Omit<GenericDecorSearchParameters, "name" | "locale">

path ​

path: string

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