Json.Encode

JSON

Build Json.Value payloads for inserts and HTTP-adjacent JSON.

Values

string

string : String -> Value

Turn a String into a JSON string.

Examples

encode (string "") == "\"\""
encode (string "abc") == "\"abc\""
encode (string "hello") == "\"hello\""

int

int : Int -> Value

Turn an Int into a JSON number.

Examples

encode (int 42) == "42"
encode (int -7) == "-7"
encode (int 0) == "0"

bool

bool : Bool -> Value

Turn a Bool into a JSON boolean.

Examples

encode (bool True) == "true"
encode (bool False) == "false"

float

float : Float -> Value

Turn a Float into a JSON number.

Examples

encode (float 3.14) == "3.14"
encode (float -42) == "-42"

null

null : Value

Create a JSON null value.

Examples

encode null == "null"

list

list : List Value -> Value

Turn a list of JSON values into a JSON array.

Examples

encode (list [ int 1, int 3, int 4 ]) == "[1,3,4]"
encode (list [ bool True, bool False ]) == "[true,false]"
encode (list [ string "a", string "b" ]) == "[\"a\",\"b\"]"

array

array : (a -> Value) -> Array a -> Value

Turn an Array into a JSON array.

Examples

encode (array int (Array.fromList [1, 3, 4])) == "[1,3,4]"
encode (array bool (Array.fromList [True, False])) == "[true,false]"

object

object : List (String, Value) -> Value

Create a JSON object from key/value pairs.

Examples

encode (object [ ("x", int 3) ]) == "{\"x\":3}"

tom =
    object
        [ ("name", string "Tom")
        , ("age", int 42)
        ]

encode tom
-- {"age":42,"name":"Tom"} or similar key order

encode

encode : Value -> String

Turn a Value into its JSON text (already UTF-8 JSON for DB storage).

Examples

encode (string "hello") == "\"hello\""
encode (int 42) == "42"
encode (list [ int 1, int 2 ]) == "[1,2]"