json v1.1.0 JSON View Source

Provides a RFC 7159, ECMA 404, and JSONTestSuite compliant JSON Encoder / Decoder

Link to this section Summary

Converts a valid JSON string into an Elixir term

Converts a valid JSON string into an Elixir term, raises errors when something bad happens

Returns a JSON string representation of the Elixir term

Returns a JSON string representation of the Elixir term, raises errors when something bad happens

decode(bitstring_or_char_list)

decode(bitstring()) :: {atom(), term()}

decode(charlist()) :: {atom(), term()}

Converts a valid JSON string into an Elixir term

iex> JSON.decode("{\"result\":\"this will be an Elixir result\"}")
{:ok, Enum.into([{"result", "this will be an Elixir result"}], Map.new)}

decode!(bitstring_or_char_list)

decode!(bitstring()) :: term()

decode!(charlist()) :: term()

Converts a valid JSON string into an Elixir term, raises errors when something bad happens

iex> JSON.decode!("{\"result\":\"this will be an Elixir result\"}")
Enum.into([{"result", "this will be an Elixir result"}], Map.new)

encode(term)

encode(term()) :: {atom(), bitstring()}

Returns a JSON string representation of the Elixir term

iex> JSON.encode([result: "this will be a JSON result"])
{:ok, "{\"result\":\"this will be a JSON result\"}"}

encode!(term)

encode!(term()) :: bitstring()

Returns a JSON string representation of the Elixir term, raises errors when something bad happens

iex> JSON.encode!([result: "this will be a JSON result"])
"{\"result\":\"this will be a JSON result\"}"