jsonapi

v1.2.3

jsonapi v1.2.3 JSONAPI.Paginator behaviour View Source

Pagination strategy behaviour

Link to this section Summary

Types

links()
options()
page()

Callbacks

paginate(data, view, conn, page, options)

Link to this section Types

Link to this type

links() View Source 
links() :: %{
  first: String.t() | nil,
  last: String.t() | nil,
  next: String.t() | nil,
  prev: String.t() | nil
}

Link to this type

options() View Source 
options() :: Keyword.t()

Link to this type

page() View Source 
page() :: map()

Link to this section Callbacks

Link to this callback

paginate(data, view, conn, page, options) View Source 
paginate(
  data :: term(),
  view :: atom(),
  conn :: Plug.Conn.t(),
  page(),
  options()
) :: links()