Specs

new(boolean() | map(), keyword()) :: t()

This function creates a new JsonXema from the given schema.

Possible options:

• :loader - a loader for remote schemas. This option will overwrite the

            loader from the config. See
            [Configure a loader](loader.html) to how to define a
            loader.

Examples

iex> ~s({"type": "string"})
...> |> Jason.decode!()
...> |> JsonXema.new()
%JsonXema{refs: %{}, schema: %Xema.Schema{type: :string}}

Specs

to_xema(%JsonXema{refs: term(), schema: term()}) :: %Xema{
  refs: term(),
  schema: term()
}

Converts %JsonXema{} to %Xema{}.

Specs

valid?(t() | schema(), any()) :: boolean()

Returns true if the value is a valid value against the given schema; otherwise returns false.

Specs

validate(t() | schema(), any(), keyword()) :: result()

Returns :ok if the value is a valid value against the given schema; otherwise returns an error tuple.

With the option :fail, you can define when the validation is aborted. This also influences how many error reasons are returned.

• :immediately aborts the validation when the first validation fails.
• :early (default) aborts on failed validations, but runs validations for all properties and items.
• :finally aborts after all possible validations.

Specs

validate!(t() | schema(), any(), keyword()) :: :ok

Returns :ok if the value is a valid value against the given schema; otherwise raises a Elixir.JsonXema.ValidationError. See validate3 for available options.