umgeher/jsx
0
Fork 0
Code Issues Pull requests Activity

document return_maps in README

Browse source
This commit is contained in:
alisdair sullivan 2014-11-24 17:27:06 -08:00
parent 989609b250
commit 3e80f475f5
2 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -483,7 +483,7 @@ decode(JSON, Opts) -> Term
JSON = json_text()
Term = json_term()
Opts = [option() | labels | {labels, Label}]
Opts = [option() | labels | {labels, Label} | return_maps]
Label = binary | atom | existing_atom | attempt_atom
F = fun((any()) -> any())
```
@ -500,6 +500,10 @@ new atoms to the atom table and will result in a `badarg` error if the atom
does not exist. `attempt_atom` will convert keys to atoms when they exist,
and leave them as binary otherwise
the option `return_maps` will attempt to return objects as maps instead of
proplists. this option has no effect when used with releases that do not
support maps
raises a `badarg` error exception if input is not valid json