/unpack

A tiny Elixir drop for safely getting values from nested maps.

Primary LanguageElixir

Unpack

This tiny Elixir drop lets you reach in and unpack any value from a nested map. Returns nil for bad keys, unloaded associations, or empty maps. Can also take a 3rd param to return a default value when key not found.

Examples

struct = %{player: %{game: %{id: "game-id"}}}
Unpack.get(struct, [:player, :game, :id])
=> "game-id"

struct = %{player: %Ecto.Association.NotLoaded{}}
Unpack.get(struct, [:player, :game, :id])
=> nil

map = %{player: %{}}
Unpack.get(map, [:player, :wrong_key], "eh!")
=> "eh!"

Docs can be found at https://hexdocs.pm/unpack.

Installation

Available as Hex package, the package can be installed by adding unpack to your list of dependencies in mix.exs:

def deps do
  [
    {:unpack, "~> 0.1.4"}
  ]
end

Testing

To test this package, run mix test. To submit a PR, please fork this repo first.