Type Alias MaplibreGeocoderApi

An API which contains reverseGeocode and forwardGeocode functions to be used by this plugin

type MaplibreGeocoderApi = {
    forwardGeocode: (
        config: MaplibreGeocoderApiConfig,
    ) => Promise<MaplibreGeocoderFeatureResults>;
    getSuggestions?: (
        config: MaplibreGeocoderApiConfig,
    ) => Promise<MaplibreGeocoderSuggestionResults>;
    reverseGeocode?: (
        config: MaplibreGeocoderApiConfig,
    ) => Promise<MaplibreGeocoderFeatureResults>;
    searchByPlaceId?: (
        config: MaplibreGeocoderApiConfig,
    ) => Promise<MaplibreGeocoderPlaceResults>;
}

Index

Properties

forwardGeocode getSuggestions? reverseGeocode? searchByPlaceId?

Properties

forwardGeocode

forwardGeocode: (
config: MaplibreGeocoderApiConfig,
) => Promise<MaplibreGeocoderFeatureResults>

Forward geocode function should return an object including a collection of CarmenGeojsonFeature.

Type Declaration

- (config: MaplibreGeocoderApiConfig): Promise<MaplibreGeocoderFeatureResults>
- Parameters
  - config: MaplibreGeocoderApiConfig
    Query parameters
  Returns Promise<MaplibreGeocoderFeatureResults>

`Optional`getSuggestions

getSuggestions?: (
config: MaplibreGeocoderApiConfig,
) => Promise<MaplibreGeocoderSuggestionResults>

`Optional`reverseGeocode

reverseGeocode?: (
config: MaplibreGeocoderApiConfig,
) => Promise<MaplibreGeocoderFeatureResults>

Reverse geocode function should return an object including a collection of CarmenGeojsonFeature.

`Optional`searchByPlaceId

searchByPlaceId?: (
config: MaplibreGeocoderApiConfig,
) => Promise<MaplibreGeocoderPlaceResults>