Jaxon (Jaxon v2.0.8) View Source

Main Jaxon module.

Link to this section Summary

Types

json_term()

Functions

decode(binary)

Decode a string.

decode!(binary)

Decode a string, throws if there's an error.

Link to this section Types

json_term()

Specs

json_term() ::
  nil
  | true
  | false
  | list()
  | float()
  | integer()
  | String.t()
  | map()
  | [json_term()]

Link to this section Functions

decode(binary)

Specs

decode(String.t()) ::
  {:ok, json_term()}
  | {:error,
     %Jaxon.ParseError{
       __exception__: term(),
       expected: term(),
       message: term(),
       unexpected: term()
     }}

Decode a string.

iex> Jaxon.decode(~s({"jaxon":"rocks","array":[1,2]}))
{:ok, %{"array" => [1, 2], "jaxon" => "rocks"}}

decode!(binary)

Specs

decode!(String.t()) :: json_term() | no_return()

Decode a string, throws if there's an error.

iex(1)> Jaxon.decode!(~s({"jaxon":"rocks","array":[1,2]}))
%{"array" => [1, 2], "jaxon" => "rocks"}