View Source Filterable (Filterable v0.7.5)

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

@spec apply!(any(), map() | Keyword.t(), module(), Keyword.t()) :: any() | no_return()

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

@spec apply_filters!(any(), map() | Keyword.t(), module(), Keyword.t()) ::
  {any(), map()} | no_return()

(macro)

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

(macro)