compass-geocoder-web/dev.jordond.compass.geocoder.web

Package-level declarations

Types

Link copied to clipboard
typealias ForwardEndpoint = HttpApiEndpoint<String, List<Coordinates>>

Alias that denotes a forward geocoding HttpApiEndpoint.

Link copied to clipboard
class ForwardHttpApiPlatformGeocoder(endpoint: ForwardEndpoint, client: HttpClient) : HttpApiPlatformGeocoder

A HttpApiPlatformGeocoder for forward geocoding that uses the provided ForwardEndpoint.

Link copied to clipboard
interface HttpApiPlatformGeocoder : PlatformGeocoder

Defines the interface for a geocoder that uses an HTTP API to perform geocoding operations.

Link copied to clipboard
typealias ReverseEndpoint = HttpApiEndpoint<Coordinates, List<Place>>

Alias that denotes a reverse geocoding HttpApiEndpoint.

Link copied to clipboard
class ReverseHttpApiPlatformGeocoder(endpoint: ReverseEndpoint, client: HttpClient) : HttpApiPlatformGeocoder

A HttpApiPlatformGeocoder for reverse geocoding that uses the provided ReverseEndpoint.

Functions

Link copied to clipboard
fun ForwardEndpoint(url: (String) -> String, mapResponse: suspend (HttpResponse) -> List<Coordinates>): ForwardEndpoint

An endpoint for forward geocoding.

Link copied to clipboard
fun HttpApiPlatformGeocoder(forwardEndpoint: ForwardEndpoint, reverseEndpoint: ReverseEndpoint, json: Json = HttpApiEndpoint.json(), client: HttpClient = HttpApiEndpoint.httpClient(json)): HttpApiPlatformGeocoder

Create a new HttpApiPlatformGeocoder with the given forwardEndpoint and reverseEndpoint.

Link copied to clipboard
fun ReverseEndpoint(url: (Coordinates) -> String, mapResponse: suspend (HttpResponse) -> List<Place>): ReverseEndpoint

An endpoint for reverse geocoding.