Class Pelias

constructor

• new Pelias(options?: Partial<PeliasOptions>): Pelias

• Parameters

  • Optionaloptions: Partial<PeliasOptions>

  Returns Pelias

options

_parseResults

• _parseResults(data: any, bboxname: any): GeocodingResult[]

• Parameters

  • data: any
  • bboxname: any

  Returns GeocodingResult[]

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<GeocodingResult[]>

• 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<GeocodingResult[]>

suggest

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

• Performs a geocoding query suggestion (this happens while typing) and returns the results as promise

  Parameters

  • query: string

    the query

  Returns Promise<GeocodingResult[]>