Skip to content

Documentation


Documentation / @blizzard-api/wow / neighborhood

Function: neighborhood() ​

neighborhood(neighborhoodMapId, neighborhoodId): object

Defined in: wow/src/neighborhood-map/index.ts:34

Get a neighborhood within a neighborhood map by ID.

Parameters ​

neighborhoodMapId ​

number

The neighborhood map ID.

neighborhoodId ​

number

The neighborhood ID.

Returns ​

The neighborhood. See NeighborhoodResponse.

_responseType? ​

optional _responseType?: NeighborhoodResponse

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.