IncidentIo.Json behaviour (IncidentIo v0.3.1)

Behaviour for JSON encoding/decoding operations.

The JSON backend defaults to Jason but is swappable via application config, which is useful in tests when you want to use a mock:

# config/test.exs
config :incident_io, :json_module, IncidentIo.Json.Mock

Any replacement module must implement the decode!/2 and encode!/2 callbacks defined by this behaviour.

Summary

Decodes a JSON binary into an Elixir term.

Encodes an Elixir term into a JSON binary.

@callback decode!(
  binary(),
  keyword()
) :: term()

@callback encode!(
  term(),
  keyword()
) :: binary()

Decodes a JSON binary into an Elixir term.

Delegates to the configured JSON module (default: Jason).

IncidentIo.Json.decode!("{"key": "value"}")
#=> %{"key" => "value"}

Encodes an Elixir term into a JSON binary.

Delegates to the configured JSON module (default: Jason).

IncidentIo.Json.encode!(%{key: "value"})
#=> "{"key":"value"}"