PhoenixHelpers.Query (phoenix_helpers v0.7.0) View Source

Link to this section Summary

Types

t()

Functions

new(includes \\ [], filters \\ [], sort_fields \\ [], default_page_size \\ nil, max_page_size \\ nil)

Link to this section Types

t()

Specs

t() :: %PhoenixHelpers.Query{
  available_filters: [binary()] | nil,
  available_includes: [binary()] | nil,
  available_sort_fields: [binary()] | nil,
  default_page_size: integer(),
  filters: keyword(),
  includes: [atom()] | nil,
  max_page_size: integer(),
  page: %{number: integer(), size: integer()} | nil,
  q: nil,
  sort_fields: keyword()
}

Link to this section Functions

new(includes \\ [], filters \\ [], sort_fields \\ [], default_page_size \\ nil, max_page_size \\ nil)

Specs

new(list(), list(), list(), integer() | nil, integer() | nil) ::
  %PhoenixHelpers.Query{
    available_filters: term(),
    available_includes: term(),
    available_sort_fields: term(),
    default_page_size: term(),
    filters: term(),
    includes: term(),
    max_page_size: term(),
    page: term(),
    q: term(),
    sort_fields: term()
  }