Class Nominatim

constructor

• new Nominatim(options?: Partial<NominatimOptions>): Nominatim

  Parameters

  • Optionaloptions: Partial<NominatimOptions>

  Returns Nominatim

options

geocode

• geocode(query: string): Promise<GeocodingResult[]>

  Performs a geocoding query and returns the results as promise

  Parameters

  • query: string

    the query

  Returns Promise<GeocodingResult[]>

reverse

• reverse(
      location: LatLngLiteral,
      scale: number,
  ): Promise<
      {
          bbox: LatLngBounds;
          center: LatLng;
          html: undefined
          | string;
          name: string;
          properties: NominatimResult;
      }[],
  >

  Performs a reverse geocoding query and returns the results as promise

  Parameters

  • location: LatLngLiteral

    the coordinate to reverse geocode
  • scale: number

    the map scale possibly used for reverse geocoding

  Returns Promise<
      {
          bbox: LatLngBounds;
          center: LatLng;
          html: undefined
          | string;
          name: string;
          properties: NominatimResult;
      }[],
  >