@smartmaps/geocoding • Docs

---

@smartmaps/geocoding / Geocoder

Class: Geocoder

Extends

• ApiCaller

Constructors

new Geocoder()

new Geocoder(apiKey, options): Geocoder

Parameters

• apiKey: string

• options: Partial\<GeocoderOptions> = {}

Returns

Geocoder

Overrides

ApiCaller.constructor

Properties

apiKey

protected apiKey: string

Inherited from

ApiCaller.apiKey

---

options

options: GeocoderOptions

Methods

checkResponse()

protected checkResponse(response): CheckResponse

Parameters

• response: unknown

Returns

CheckResponse

Inherited from

ApiCaller.checkResponse

---

geocode()

geocode(address, options): Promise\<GeocoderResponseCollection>

Parameters

• address: NullablePartial\<GeocoderRequestAddress>

• options: Partial\<GeocoderMethodCallOptions> = {}

Returns

Promise\<GeocoderResponseCollection>

---

geocodeReverse()

geocodeReverse(latlng, options): Promise\<GeocoderResponseCollection>

Parameters

• latlng: LatLngExpression

• options: Partial\<GeocoderMethodCallOptions> = {}

Returns

Promise\<GeocoderResponseCollection>

---

geocodeString()

geocodeString(address, options): Promise\<GeocoderResponseCollection>

Parameters

• address: string | CountryAndSingleSlot

• options: Partial\<GeocoderMethodCallOptions> = {}

Returns

Promise\<GeocoderResponseCollection>

---

getRequestInfo()

protected getRequestInfo(request): Promise\<object>

Parameters

• request: string

Returns

Promise\<object>

bodyPart

bodyPart: object

requestPart

requestPart: Partial\<RequestInit>

url

url: string

Inherited from

ApiCaller.getRequestInfo