potion v1.1.1 Potion

Summary

Functions

check empty

Gets the value for a specific key

Puts the given value

Puts the given value

Collection trim

Deletes the given value from key

Deletes the given value from value

Functions

empty?(data)
empty?(any) :: boolean

check empty

Examples

Potion.empty?([])
true
Potion.empty?(%{})
true
Potion.empty?({})
true
Potion.empty?("")
true
Potion.empty?(nil)
true
Potion.empty?(false)
true

Potion.empty?([1,2])
false
Potion.empty?(%{map: "some content"})
false
Potion.empty?({1, 2})
false
Potion.empty?("some content")
false
Potion.empty?(1)
false
Potion.empty?(true)
false
get(data, key, default \\ nil)
get(Map.t | List.t | Tuple.t, String.t | Integer.t | Atom.t, any) :: any

Gets the value for a specific key

Examples

Potion.get([1,2,3], 0)
1
Potion.get([1,2,3], 4)
nil
Potion.get({1,2,3}, 0)
1
Potion.get([index: 1, index2: 2], :index2)
2
Potion.get({:ok, "some content"}, :ok)
"some content"
Potion.get(%{map: "some content"}, :map)
"some content"
Potion.get([1,2,3], 4, 0)
0
put(data, item)
put(Map.t | List.t | Tuple.t, any) ::
  Map.t |
  List.t |
  Tuple.t

Puts the given value

Examples

Potion.put([1], 2)
[1,2]
Potion.put([1], [2])
[1,2]
Potion.put(%{map: "some content"}, add: "some content")
%{map: "some content", add: "some content"}
Potion.put(%{map: "some content"}, [add: "some content"])
%{map: "some content", add: "some content"}
Potion.put(%{map: "some content"}, %{add: "some content"})
%{map: "some content", add: "some content"}
Potion.put(%{map: "some content"}, %{map: "some content!"})
%{map: "some content!"}
Potion.put({1,2,3}, 4)
{1,2,3,4}
put_first(data, item)
put_first(Map.t | List.t | Tuple.t, any) ::
  Map.t |
  List.t |
  Tuple.t

Puts the given value

Examples

Potion.put_first([1], 2)
[2,1]
Potion.put_first([1], [2])
[2,1]
Potion.put_first(%{map: "some content"}, add: "some content")
%{add: "some content", map: "some content"}
Potion.put_first(%{map: "some content"}, [add: "some content"])
%{add: "some content", map: "some content"}
Potion.put_first(%{map: "some content"}, %{add: "some content"})
%{add: "some content", map: "some content"}
Potion.put_first(%{map: "some content"}, %{map: "some content!"})
%{map: "some content"}
Potion.put_first({1,2,3}, 4)
{4,1,2,3}
trim(data)
trim(Map.t | List.t | Tuple.t) :: Map.t | List.t | Tuple.t

Collection trim

Examples

Potion.trim([1,"",3])
[1,3]
Potion.trim(%{map: "some content", map2: ""})
%{map: "some content"}
Potion.trim({1, ""})
{1}
unset(data, key)
unset(Map.t | List.t | Tuple.t, String.t | Integer.t | Atom.t | List.t) :: any

Deletes the given value from key

Examples

Potion.unset([1,2], 0)
[2]
Potion.unset(%{a: 1, b: 2}, :a)
%{b: 2}
Potion.unset({1,2}, 0)
{2}
Potion.unset([1,2], [0,1])
[]
Potion.unset(%{a: 1, b: 2}, [:a, :b])
%{}
Potion.unset({1,2}, [1,2])
{1}
unset_value(data, value)
unset_value(Map.t | List.t | Tuple.t, String.t | Integer.t | Atom.t | List.t) :: any

Deletes the given value from value

Examples

Potion.unset_value([1,2], 2)
[1]
Potion.unset_value([1,2], [0,1])
[2]
Potion.unset_value(%{a: 1, b: 2}, 1)
%{b: 2}
Potion.unset_value(%{a: 1, b: 2}, [1, 2])
%{}
Potion.unset_value({1,2}, 2)
{1}
Potion.unset_value({1,2}, [1,2])
{}