https://github.com/ottojimb/deep_clean
Exclude elements from deep nested maps/list
https://github.com/ottojimb/deep_clean
elixir
Last synced: 10 months ago
JSON representation
Exclude elements from deep nested maps/list
- Host: GitHub
- URL: https://github.com/ottojimb/deep_clean
- Owner: ottojimb
- Created: 2017-03-23T19:48:14.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-04T03:09:37.000Z (about 9 years ago)
- Last Synced: 2025-08-10T18:37:26.642Z (11 months ago)
- Topics: elixir
- Language: Elixir
- Size: 5.86 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DeepClean
Provide functionality to exclude elements in nested maps or list.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `deep_clean` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:deep_clean, "~> 0.1.1"}]
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm).
The docs can be found at [https://hexdocs.pm/deep_clean](https://hexdocs.pm/deep_clean).
## Usage
Simply call the `DeepClean.exclude_in/2` function sending the following params:
1. `deep_elem`: a *map* or *list* with nested elements
2. `clean_list`: a *list* with the keys to be exclude from the *deep_elem*
separated by dots by each nested level
## Example
```elixir
iex> DeepClean.exclude_in(%{a: %{aa: 1, ab: 2}, b: %{ba: 3, bb: 4}}, ["a.ab", "b.bb"])
.. > %{a: %{aa: 1}, b: %{ba: 3}}
iex> DeepClean.exclude_in(%{a: [%{aa: 1, ab: 2}, %{aa: 11, ab: 22},], b: [%{ba: 3, bb: 4}, %{ba: 33, bb: 44}]}, ["a.ab", "b.bb"])
.. > %{a: [%{aa: 1}, %{aa: 11}], b: [%{ba: 3}, %{ba: 33}]}
```