TzWord v0.7.1 TzWorld.Backend behaviour View Source

Defines the callbacks for the TzWorld.Backend behaviour

Link to this section Summary

Types

A point

Latitude in degrees

Longitude in degrees

Callbacks

Returns all timezones at a specified point

Reloads the (potentially updated) timezone data

Returns the time zone at a specified point

Link to this section Types

Specs

geo() :: Geo.Point.t()

A point

Specs

lat() :: -90..90

Latitude in degrees

Specs

lng() :: -180..180

Longitude in degrees

Link to this section Callbacks

Specs

all_timezones_at(Geo.Point.t()) :: {:ok, [String.t()]} | {:error, atom()}

Returns all timezones at a specified point

Specs

reload_timezone_data() :: {:ok, term()}

Reloads the (potentially updated) timezone data

Specs

timezone_at(geo()) :: {:ok, String.t()} | {:error, atom()}

Returns the time zone at a specified point