Filtrex.Type.Config (Filtrex v0.5.0)

This configuration struct is for passing options at the top-level (e.g. Filtrex.parse/2) in a list. See defconfig/1 for a more specific example.

Struct keys:

type: the corresponding condition module with this type (e.g. :text = Filtrex.Condition.Text)
keys: the allowed keys for this configuration
options: the configuration options to be passed to the condition

Summary

Types

t()

Functions

allowed?(configs, key)

Returns whether the passed key is listed in any of the configurations

boolean(key_or_keys, opts \\ [])

Generate a config struct for Filtrex.Condition.Boolean

config(configs, key)

Returns the configuration for the specified key

configs_for_type(configs, type)

Narrows the list of configurations to only the specified type

date(key_or_keys, opts \\ [])

Generate a config struct for Filtrex.Condition.Date

datetime(key_or_keys, opts \\ [])

Generate a config struct for Filtrex.Condition.DateTime

defconfig(block)

Allows easy creation of a configuration list

number(key_or_keys, opts \\ [])

Generate a config struct for Filtrex.Condition.Number

options(configs, key)

Returns the specific options of a configuration based on the key

text(key_or_keys, opts \\ [])

Generate a config struct for Filtrex.Condition.Text

to_strings(keys, strings \\ [])

Convert a list of mixed atoms and/or strings to a list of strings

Types

t()

@type t() :: Filtrex.Type.Config

Functions

allowed?(configs, key)

Returns whether the passed key is listed in any of the configurations

boolean(key_or_keys, opts \\ [])

(macro)

Generate a config struct for Filtrex.Condition.Boolean

config(configs, key)

Returns the configuration for the specified key

configs_for_type(configs, type)

Narrows the list of configurations to only the specified type

date(key_or_keys, opts \\ [])

(macro)

Generate a config struct for Filtrex.Condition.Date

datetime(key_or_keys, opts \\ [])

(macro)

Generate a config struct for Filtrex.Condition.DateTime

defconfig(block)

(macro)

Allows easy creation of a configuration list:

iex> import Filtrex.Type.Config
iex>
iex> defconfig do
iex>   # Single key can be passed
iex>   number :rating, allow_decimal: true
iex>
iex>   # Multiple keys
iex>   text [:title, :description]
iex>
iex>   # String key can be passed
iex>   date "posted", format: "{ISOz}"
iex> end
[
  %Filtrex.Type.Config{keys: ["rating"], options: %{allow_decimal: true}, type: :number},
  %Filtrex.Type.Config{keys: ["title", "description"], options: %{}, type: :text},
  %Filtrex.Type.Config{keys: ["posted"], options: %{format: "{ISOz}"}, type: :date}
]

number(key_or_keys, opts \\ [])

(macro)

Generate a config struct for Filtrex.Condition.Number

options(configs, key)

Returns the specific options of a configuration based on the key

text(key_or_keys, opts \\ [])

(macro)

Generate a config struct for Filtrex.Condition.Text

to_strings(keys, strings \\ [])

Convert a list of mixed atoms and/or strings to a list of strings