Flop.Filter (Flop v0.8.2) View Source

Defines a filter.

Link to this section Summary

Types

Represents valid filter operators.

t()

Represents filter query parameters.

Link to this section Types

Specs

op() :: :== | :!= | :=~ | :<= | :< | :>= | :> | :in

Represents valid filter operators.

Specs

t() :: %Flop.Filter{field: atom() | String.t(), op: op(), value: any()}

Represents filter query parameters.

Fields

  • field: The field the filter is applied to. The allowed fields can be restricted by deriving Flop.Schema in your Ecto schema.
  • op: The filter operator.
  • value: The comparison value of the filter.