aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 9a0c9fc7517bc3724dfd59b782d220e03155c797 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# json 🐑

Work with JSON in Gleam!

Under the hood library uses [Thoas](https://github.com/lpil/thoas/), the fastest
and most memory efficient pure Erlang JSON encoder/decoder.

## Installation

Add this package to your Gleam project.

```shell
gleam add gleam_json
```

### Encoding

```rust
import myapp.{Cat}
import gleam/list
import gleam/json.{object, string, list, int, null}

pub fn cat_to_json(cat: Cat) -> String {
  object([
    #("name", string(cat.name)),
    #("lives", int(9),
    #("flaws", null()),
    #("nicknames", array(["Kitty", "Sweetie"], of: string)),
  ])
  |> json.to_string
}
```

### Decoding

JSON is decoded into a `Dynamic` value which can be decoded using the
`gleam/dynamic` module from the Gleam standard library.

```rust
import myapp.{Cat}
import gleam/json
import gleam/dynamic
import gleam/result

pub fn cat_from_json(json: String) -> Result<Cat, MyError> {
  try data = 
    json.decode(encoded)
    |> result.map_error(InvalidJson)

  let data = dynamic.from(data)
  try cat = {
    try name = dynamic.field(data, "name")
    try name = dynamic.string(name)
    Ok(Cat(name))
  }
  |> result.map_error(InvalidFormat)

  Ok(cat)
}

pub type MyError {
  InvalidJson(json.DecodeError)
  InvalidFormat(dynamic.DecodeError)
}
```