Scrypath.Query (scrypath v0.3.0)

Internal normalized search query struct used by the common search path and backend adapters.

Summary

page_t()

Normalized pagination options.

t()

Internal normalized search query.

new(text, opts)

@type page_t() :: %{
  optional(:number) => pos_integer(),
  optional(:size) => pos_integer()
}

Normalized pagination options.

@type t() :: %Scrypath.Query{
  filter: keyword(),
  page: page_t(),
  sort: keyword(),
  text: String.t()
}

Internal normalized search query.

@spec new(
  String.t(),
  keyword()
) :: t()