Miffy
=====

[![Travis](https://img.shields.io/travis/expelledboy/miffy.svg)](https://travis-ci.org/expelledboy/miffy)
[![Hex.pm](https://img.shields.io/hexpm/v/miffy.svg)](https://hex.pm/packages/miffy)
[![Hex.pm](https://img.shields.io/hexpm/dt/miffy.svg)](https://hex.pm/packages/miffy)

Jiffy and JSX wrapper which returns a more standard Erlang map.

### Usage

Optional data types can be passed as a second parameter, to provide seemless translation.

```erlang
{deps,
 [
  {miffy, ".*", {git, "https://github.com/expelledboy/miffy.git", {tag, "2.0.0"}}},
  %% which requires either peer dependency
  {jiffy, ".*", {git, "https://github.com/davisp/jiffy.git", {tag, "0.14.11"}}},
  {jsx, ".*", {git, "https://github.com/talentdeficit/jsx.git", {tag, "v2.9.0"}}}
 ]}.
```

```erlang
Types = #{ atom => atom,
	   string => string,
	   collection => {collection, #{ key => atom }},
	   obj => #{ sub => atom } },
Erlang = #{ atom => value,
	    list => ["value"],
	    collection => [#{ key => one }, #{ key => two }],
	    string => "value",
	    bool => true,
	    integer => 1,
	    float => 1.0,
	    obj => #{ sub => value } },
Json = miffy:encode(Erlang, Types),
AtomStr = '{"string":"value","obj":{"sub":"value"},"list":[[118,97,108,117,101]],"integer":1,"float":1.0,"collection":[{"key":"two"},{"key":"one"}],"bool":true,"atom":"value"}',
Json = erlang:atom_to_binary(AtomStr, latin1), %% HACK dont do this to create strings
Erlang = miffy:decode(Json, Types).
```

### Note

Miffy does NOT attempt to translate lists deeply, see unit tests for example behaviour.

However (as seen above) a collection type exists, which is a list containing objects of the same type.