View Source Geocoder.Provider behaviour (geocoder v2.2.1)

Specifies expected behaviour for a provider

Summary

option()

options()

payload()

@type option() ::
  {:json_codec, atom()}
  | {:http_client, atom()}
  | {:http_client_opts, term()}
  | {:key, binary()}
  | {:data, term()}

@type options() :: [option()]

@type payload() :: keyword()

@callback geocode(payload(), options()) :: {:ok, Geocoder.Coords.t()} | {:error, any()}

@callback geocode_list(payload(), options()) ::
  {:ok, Geocoder.Coords.t()} | {:error, any()}

@callback reverse_geocode(payload(), options()) ::
  {:ok, Geocoder.Coords.t()} | {:error, any()}

@callback reverse_geocode_list(payload(), options()) ::
  {:ok, Geocoder.Coords.t()} | {:error, any()}