simplejson

SimpleJSON

Basic JSON library for Gleam. To be used for simple conversion from string to a basic JSON structure and to then output that as a string again.

Values

jsonpath

</>

pub fn jsonpath(
  json: jsonvalue.JsonValue,
  jsonpath: String,
) -> Result(jsonvalue.JsonValue, jsonvalue.JsonPathError)

Simple jsonpath style querying method

A simple . separated list of path elements to take

names are as-is
indexes are prefixes by #
consecutive separators are ignored
e.g. key1.#3…nextkey

Examples

let assert Ok(json) = simplejson.parse("{\"a\":[1,2,{\"b\":123}]}")
simplejson.jsonpath(json, "a.#2.b")
// -> JsonNumber(Some(123), None, Some("123"))

parse

</>

pub fn parse(
  json: String,
) -> Result(jsonvalue.JsonValue, jsonvalue.ParseError)

Parse a given string into a JsonValue Result. Or return Error if unable.

Thie returns a useful description of the parse failure utilising the ParseError types.

The error will either be UnexpectedEnd or a specific reason containing the character/value that failed to parse, a context which contains the surrounding up to 10 characters and the character index of the failure point

Examples

parse("{\"a\":123,\"b\":[true, false]}")
// -> Ok(JsonObject(dict.from_list([#("a", JsonNumber(Some(123), None, Some("123"))), #("b", JsonArray([JsonBool(True), JsonBool(False)]))])))

parse("[1,2,3]")
// -> Ok(JsonArray([JsonNumber(Some(1), None, Some("1")), JsonNumber(Some(2), None, Some("2")), JsonNumber(Some(3), None, Some("3"))]))

parse("[1,2,3,]")
// -> Error(UnexpectedCharacter("]", ",2,3,]", 7))

to_string

</>

pub fn to_string(json: jsonvalue.JsonValue) -> String

Convert a given JsonValue into a String

Examples

to_string(JsonArray([JsonNumber(Some(1), None, Some("1")), JsonNumber(Some(2), None, Some("2")), JsonNumber(Some(3), None, Some("3"))]))
// -> "[1,2,3]"