Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify how to use options in README #193

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarify how to use options in README #193

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,25 @@ end
For maximum performance, make sure you `@derive [Poison.Encoder]` for any
struct you plan on encoding.

### Pretty print and other options


You can set options for the encoder.

```
Poison.encode!(data, pretty: true)
```

List of all options found in [/lib/poison/encoder.ex](https://github.com/devinus/poison/blob/e21f5f92c39dcbd192185cd41c89e4d58fa753f3/lib/poison/encoder.ex#L84).

```
@typep escape :: :unicode | :javascript | :html_safe
@typep pretty :: boolean
@typep indent :: non_neg_integer
@typep offset :: non_neg_integer
@typep strict_keys :: boolean
```

### Encoding only some attributes

When deriving structs for encoding, it is possible to select or exclude
Expand Down