View Source Drops.Predicates (drops v0.1.0)

Drops.Predicates is a module that provides validation functions that can be used as the type constraints.

Summary

Functions

empty?(input)

Checks if a given input is empty

eql?(value, input)

Checks if a given value is equal to another value

even?(input)

Checks if a given integer is even

excludes?(element, input)

Checks if a given element is not included in a given list

filled?(input)

Checks if a given input is not empty

gt?(value, input)

Checks if a given input is greater than another value

gteq?(value, input)

Checks if a given value is greater than or equal to another value

in?(list, input)

Checks if a given element is included in a given list

includes?(element, input)

Checks if a given element is included in a given list

lt?(value, input)

Checks if a given input is less than another value

lteq?(value, input)

Checks if a given input is less than or equal to another value

match?(regexp, input)

Checks if a given string matches a given regular expression

max_size?(size, input)

Checks if a given map, list or string size is less than or equal to a given size

min_size?(size, input)

Checks if a given map, list or string size is greater than or equal to a given size

not_eql?(value, input)

Checks if a given value is not equal to another value

not_in?(list, input)

Checks if a given element is not included in a given list

odd?(input)

Checks if a given integer is odd

size?(size, input)

Checks if a given list, map or string size is equal to a given size

type?(arg1, input)

Checks if a given value matches a given type identifier

Functions

empty?(input)

@spec empty?(input :: binary() | list() | map()) :: boolean()

Checks if a given input is empty

Examples

iex> Drops.Predicates.empty?("hello")
false
iex> Drops.Predicates.empty?("")
true
iex> Drops.Predicates.empty?(["hello", "world"])
false
iex> Drops.Predicates.empty?(%{hello: "world"})
false
iex> Drops.Predicates.empty?(%{})
true

eql?(value, input)

@spec eql?(value :: any(), input :: any()) :: boolean()

Checks if a given value is equal to another value

Examples

iex> Drops.Predicates.eql?("hello", "hello")
true
iex> Drops.Predicates.eql?("hello", "world")
false

even?(input)

@spec even?(input :: integer()) :: boolean()

Checks if a given integer is even

Examples

iex> Drops.Predicates.even?(4)
true
iex> Drops.Predicates.even?(7)
false

excludes?(element, input)

@spec excludes?(element :: any(), input :: list()) :: boolean()

Checks if a given element is not included in a given list

Examples

iex> Drops.Predicates.excludes?(1, [1, 2, 3])
false
iex> Drops.Predicates.excludes?(4, [1, 2, 3])
true

filled?(input)

@spec filled?(input :: binary() | list() | map()) :: boolean()

Checks if a given input is not empty

Examples

iex> Drops.Predicates.filled?("hello")
true
iex> Drops.Predicates.filled?("")
false
iex> Drops.Predicates.filled?(["hello", "world"])
true
iex> Drops.Predicates.filled?(%{hello: "world"})
true
iex> Drops.Predicates.filled?(%{})
false

gt?(value, input)

@spec gt?(value :: any(), input :: any()) :: boolean()

Checks if a given input is greater than another value

Examples

iex> Drops.Predicates.gt?(2, 1)
false
iex> Drops.Predicates.gt?(1, 2)
true

gteq?(value, input)

@spec gteq?(value :: any(), input :: any()) :: boolean()

Checks if a given value is greater than or equal to another value

Examples

iex> Drops.Predicates.gteq?(2, 1)
false
iex> Drops.Predicates.gteq?(1, 1)
true
iex> Drops.Predicates.gteq?(1, 2)
true

in?(list, input)

@spec in?(list :: list(), input :: any()) :: boolean()

Checks if a given element is included in a given list

Examples

iex> Drops.Predicates.in?([1, 2, 3], 2)
true
iex> Drops.Predicates.in?([1, 2, 3], 4)
false

includes?(element, input)

@spec includes?(element :: any(), input :: list()) :: boolean()

Checks if a given element is included in a given list

Examples

iex> Drops.Predicates.includes?(1, [1, 2, 3])
true
iex> Drops.Predicates.includes?(4, [1, 2, 3])
false

lt?(value, input)

@spec lt?(value :: any(), input :: any()) :: boolean()

Checks if a given input is less than another value

Examples

iex> Drops.Predicates.lt?(2, 1)
true
iex> Drops.Predicates.lt?(1, 2)
false

lteq?(value, input)

@spec lteq?(value :: any(), input :: any()) :: boolean()

Checks if a given input is less than or equal to another value

Examples

iex> Drops.Predicates.lteq?(2, 1)
true
iex> Drops.Predicates.lteq?(1, 1)
true
iex> Drops.Predicates.lteq?(1, 2)
false

match?(regexp, input)

@spec match?(regexp :: Regex.t(), input :: binary()) :: boolean()

Checks if a given string matches a given regular expression

Examples

iex> Drops.Predicates.match?(~r/hello/, "hello world")
true
iex> Drops.Predicates.match?(~r/hello/, "world")
false

max_size?(size, input)

@spec max_size?(size :: integer(), input :: map() | list() | String.t()) :: boolean()

Checks if a given map, list or string size is less than or equal to a given size

Examples

iex> Drops.Predicates.max_size?(2, "a")
true
iex> Drops.Predicates.max_size?(2, "ab")
true
iex> Drops.Predicates.max_size?(2, "abc")
false
iex> Drops.Predicates.max_size?(2, [1, 2])
true
iex> Drops.Predicates.max_size?(2, [1, 2, 3])
false
iex> Drops.Predicates.max_size?(2, %{a: 1, b: 2})
true
iex> Drops.Predicates.max_size?(2, %{a: 1, b: 2, c: 3})
false

min_size?(size, input)

@spec min_size?(size :: integer(), input :: map() | list() | String.t()) :: boolean()

Checks if a given map, list or string size is greater than or equal to a given size

Examples

iex> Drops.Predicates.min_size?(2, "ab")
true
iex> Drops.Predicates.min_size?(2, "abc")
true
iex> Drops.Predicates.min_size?(2, "a")
false
iex> Drops.Predicates.min_size?(2, [1, 2])
true
iex> Drops.Predicates.min_size?(2, [1])
false
iex> Drops.Predicates.min_size?(2, %{a: 1, b: 2})
true
iex> Drops.Predicates.min_size?(2, %{a: 1})
false

not_eql?(value, input)

@spec not_eql?(value :: any(), input :: any()) :: boolean()

Checks if a given value is not equal to another value

Examples

iex> Drops.Predicates.not_eql?("hello", "hello")
false
iex> Drops.Predicates.not_eql?("hello", "world")
true

not_in?(list, input)

@spec not_in?(list :: list(), input :: any()) :: boolean()

Checks if a given element is not included in a given list

Examples

iex> Drops.Predicates.not_in?([1, 2, 3], 2)
false
iex> Drops.Predicates.not_in?([1, 2, 3], 4)
true

odd?(input)

@spec odd?(input :: integer()) :: boolean()

Checks if a given integer is odd

Examples

iex> Drops.Predicates.odd?(4)
false
iex> Drops.Predicates.odd?(7)
true

size?(size, input)

@spec size?(size :: integer(), input :: map() | list() | String.t()) :: boolean()

Checks if a given list, map or string size is equal to a given size

Examples

iex> Drops.Predicates.size?(2, "ab")
true
iex> Drops.Predicates.size?(2, "abc")
false
iex> Drops.Predicates.size?(2, [1, 2])
true
iex> Drops.Predicates.size?(2, [1, 2, 3])
false
iex> Drops.Predicates.size?(2, %{a: 1, b: 2})
true
iex> Drops.Predicates.size?(2, %{a: 1, b: 2, c: 3})
false

type?(arg1, input)

@spec type?(type :: atom(), input :: any()) :: boolean()

Checks if a given value matches a given type identifier

Examples

iex> Drops.Predicates.type?(:nil, nil)
true
iex> Drops.Predicates.type?(:any, nil)
true
iex> Drops.Predicates.type?(:any, "foo")
true
iex> Drops.Predicates.type?(:atom, :hello)
true
iex> Drops.Predicates.type?(:boolean, true)
true
iex> Drops.Predicates.type?(:boolean, false)
true
iex> Drops.Predicates.type?(:string, "hello")
true
iex> Drops.Predicates.type?(:integer, 1)
true
iex> Drops.Predicates.type?(:float, 1.2)
true
iex> Drops.Predicates.type?(:map, %{})
true
iex> Drops.Predicates.type?(:date_time, DateTime.utc_now())
true

Settings View Source Drops.Predicates (drops v0.1.0)

empty?(input)

eql?(value, input)

even?(input)

excludes?(element, input)

filled?(input)

gt?(value, input)

gteq?(value, input)

in?(list, input)

includes?(element, input)

lt?(value, input)

lteq?(value, input)

match?(regexp, input)

max_size?(size, input)

min_size?(size, input)

not_eql?(value, input)

not_in?(list, input)

odd?(input)

size?(size, input)

type?(arg1, input)

View Source Drops.Predicates (drops v0.1.0)