Type Alias GeocodingOptions

GeocodingOptions: CommonForwardAndReverseGeocodingOptions & {
    autocomplete?: boolean;
    bbox?: BBox;
    country?: string[];
    fuzzyMatch?: boolean;
    proximity?: Position | "ip";
}

Type Declaration

  • Optionalautocomplete?: boolean

    Set to true to use autocomplete, false to disable it. Default is true.

  • Optionalbbox?: BBox

    Only search for results in the specified area.

  • Optionalcountry?: string[]

    Limit search to specific country/countries specified as list of Alpha-2 ISO 3166-1 codes.

  • OptionalfuzzyMatch?: boolean

    Set to false to disable fuzzy (typo-tolerant) search. Default is true.

  • Optionalproximity?: Position | "ip"

    Prefer results close to a specific location.

Was this helpful?

Client JS
Reference
GeocodingOptions