View Source Bonfire.API.GraphQL.Pages (Bonfire v0.9.10-classic-beta.169)

Summary

Types

counts()
data()
t()

Functions

get(pages, key)

Returns a Page for the given key, defaulting to an empty one

getter(key)

Returns a post-batch callback (i.e. the third argument to batch/3) for a key which calls get() with the callback param and the key

new(data, counts, cursor_fn, page_opts)

Create a new pages from a data map, counts map, cursor function and page opts

new(data_rows, count_rows, group_fn, cursor_fn, page_opts)

Create a new Pages from some data rows, count rows and a grouping key. Groups the data by the grouping key on insertion and turns the counts into a map ready for lookup on a per-row basis.

Types

Link to this type

counts()

View Source 
@type counts() :: %{required(term()) => non_neg_integer()}
Link to this type

data()

View Source 
@type data() :: %{required(term()) => term()}
Link to this type

t()

View Source 
@type t() :: %Bonfire.API.GraphQL.Pages{
  counts: counts(),
  cursor_fn: (term() -> term()),
  data: data(),
  page_opts: term()
}

Functions

Link to this function

get(pages, key)

View Source

Returns a Page for the given key, defaulting to an empty one

Link to this function

getter(key)

View Source

Returns a post-batch callback (i.e. the third argument to batch/3) for a key which calls get() with the callback param and the key

Link to this function

new(data, counts, cursor_fn, page_opts)

View Source

Create a new pages from a data map, counts map, cursor function and page opts

Link to this function

new(data_rows, count_rows, group_fn, cursor_fn, page_opts)

View Source

Create a new Pages from some data rows, count rows and a grouping key. Groups the data by the grouping key on insertion and turns the counts into a map ready for lookup on a per-row basis.

Note: if the grouping key is not present in the returned data rows, this function will crash. Our intuition is that this would mean an error in the calling code, so we would rather raise it early.