Class: Address

bemap.Address(optionsopt)

new Address(optionsopt)

BeNomad BeMap JavaScript API - Address (structured query input) Lightweight value object used to build a structured geocoding query. Distinct from `bemap.PostalAddress`, which represents the *result* of a lookup. The v1.5 `Geocoder.geocode()` request accepts either an `address` (this class — for structured input) or a `place` string (free-text input). Every field is optional. Fields the server cannot use are silently ignored.
Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Description
countryCode String <optional>
country String <optional>
state String <optional>
county String <optional>
city String <optional>
district String <optional>
postalCode String <optional>
street String <optional>
streetNumber String <optional>
Since:
  • 1.5.0
Source:

Methods

toJson() → {Object}

Serialise the address to the JSON shape expected by the BeMap geocoding Worker. `null` / `undefined` fields are stripped so the request body stays minimal.
Source:
Returns:
Type
Object