Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IStreetStructuredGeocodeArgs

An interface for a StreetStructuredGeocodeArgs object, used for the arguments of a structured geocode that has more detailed street information.

Hierarchy

Index

Properties

city

city: string

The city to search in.

country

country: Country

The country to search within.

Optional maxResults

maxResults: number

The maximum number of search results to return.

name

name: string

The street name to search for.

number

number: number

The street number to search for.

postalCode

postalCode: string

The postal (or ZIP) code to search for.

Optional prefix

prefix: string

A string representing the street prefix, such as 'chemin' or 'north'.

region

region: string

The region to search in.

Optional streetTypeAfter

streetTypeAfter: string

A string representing the street type, when it appears after the street name, such as 'street' or 'road'.

Optional streetTypeBefore

streetTypeBefore: string

A string representing the street type, when it appears before the street name, such as 'rue' or 'boulevard'.

Optional suffix

suffix: string

A string representing the street prefix, such as 'north', 'central', or 'loop'.

Optional useExternalGeocoder

useExternalGeocoder: boolean

Whether or not to use an external geocoder (if available).

Optional useInternalGeocoder

useInternalGeocoder: boolean

Whether or not to use the built-in geocoder.

Generated using TypeDoc