Cursor Paginator v0.6.1 CursorPaginator.Page.Metadata View Source

Defines page metadata.

Fields

  • after - an opaque cursor representing the last row of the current page.
  • before - an opaque cursor representing the first row of the current page.
  • limit - the maximum number of entries that can be contained in this page.
  • total_count - the total number of entries matching the query.
  • total_count_cap_exceeded - a boolean indicating whether the :total_count_limit was exceeded.

Link to this section Summary

Link to this section Types

Link to this type

opaque_cursor() View Source
opaque_cursor() :: String.t()

Link to this type

t() View Source
t() :: %CursorPaginator.Page.Metadata{
  after: opaque_cursor(),
  before: opaque_cursor(),
  limit: integer(),
  total_count: integer(),
  total_count_cap_exceeded: boolean()
}