Filterable v0.5.3 Filterable View Source

Filterable allows to map incoming parameters to filter functions.

This module contains common functions (apply_filters/3, filter_values/2) which allow to run filters in simple functional Elixir way and filterable macro which allows to build filters using DSL (see Filterable.DSL)

Link to this section Summary

Functions

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

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

define_module(module, list)

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

filterable(arg, opts \\ [])

Link to this section Functions

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

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

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

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

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)