Paginator v1.2.0

View Source Paginator.Page.Metadata (Paginator v1.2.0)

Defines page metadata.

fields

 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

Types

opaque_cursor()
t()

Link to this section Types

Link to this type

opaque_cursor()

View Source

Specs

opaque_cursor() :: String.t()
Link to this type

t()

View Source

Specs

t() :: %Paginator.Page.Metadata{
  after: opaque_cursor() | nil,
  before: opaque_cursor() | nil,
  limit: integer(),
  total_count: integer() | nil,
  total_count_cap_exceeded: boolean() | nil
}