Filterable v0.7.1 Filterable View Source

Filterable allows to map incoming parameters to filter functions.

This module contains functions (apply_filters/3, filter_values/2) which allow to perform filtering and filterable macro which allows to define available filters using DSL (see Filterable.DSL).

Link to this section Summary

apply_filters!(queryable, params, module, opts \\ [])

apply_filters!(any(), map() | Keyword.t(), module(), Keyword.t()) ::
  any() | no_return()

apply_filters(queryable, params, module, opts \\ [])

apply_filters(any(), map() | Keyword.t(), module(), Keyword.t()) ::
  {:ok, any(), map()} | {:error, String.t()}

define_module(module, list) (macro)

filter_values(params, module, opts \\ [])

filter_values(map() | Keyword.t(), module(), Keyword.t()) ::
  {:ok, map()} | {:error, String.t()}

filterable(arg, opts \\ []) (macro)