Kagi.Maps (kagi_ex v0.1.0)

Copy Markdown View Source

Maps response returned by Kagi.maps/1..3.

Contains parsed point-of-interest rows. Sorting and limiting are applied client-side after the response is parsed.

Fields

  • :results - point-of-interest rows in result order.

Summary

Types

order()

Sort direction passed via the :order option.

sort()

Maps sort mode passed via the :sort option.

t()

A parsed Kagi Maps response.

Types

order()

@type order() :: :asc | :desc

Sort direction passed via the :order option.

sort()

@type sort() :: :relevance | :rating | :distance | :price

Maps sort mode passed via the :sort option.

t()

@type t() :: %Kagi.Maps{results: [Kagi.MapsResult.t()]}

A parsed Kagi Maps response.