Jido.Browser.Error (Jido Browser v2.1.0)

@type class() :: %{
  :__struct__ => class_module(),
  :__exception__ => true,
  :errors => [t()],
  :class => error_class(),
  :bread_crumbs => [String.t()],
  :vars => Keyword.t(),
  :stacktrace => Splode.Stacktrace.t() | nil,
  :context => map(),
  optional(atom()) => any()
}

class_module()

@type class_module() ::
  Timeout | Element | Navigation | Adapter | Invalid | Splode.Error.Unknown

error_class()

@type error_class() ::
  :timeout | :element | :navigation | :adapter | :invalid | :unknown

t()

@type t() :: %{
  :__struct__ => module(),
  :__exception__ => true,
  :class => error_class(),
  :bread_crumbs => [String.t()],
  :vars => Keyword.t(),
  :stacktrace => Splode.Stacktrace.t() | nil,
  :context => map(),
  optional(atom()) => any()
}

Functions

adapter_error(message, details \\ %{})

@spec adapter_error(String.t(), map()) :: Jido.Browser.Error.AdapterError.t()

Creates an adapter error with the given message and optional details.

element_error(action, selector, reason)

@spec element_error(String.t(), String.t(), term()) ::
  Jido.Browser.Error.ElementError.t()

Creates an element error for the given action, selector, and reason.

invalid_error(message, details \\ %{})

@spec invalid_error(String.t(), map()) :: Jido.Browser.Error.InvalidError.t()

Creates an invalid input/state error with the given message and optional details.

navigation_error(url, reason)

@spec navigation_error(String.t() | nil, term()) ::
  Jido.Browser.Error.NavigationError.t()

Creates a navigation error for the given URL and reason.

splode_error?(arg1, splode)

timeout_error(operation, timeout_ms)

@spec timeout_error(String.t(), non_neg_integer()) ::
  Jido.Browser.Error.TimeoutError.t()

Creates a timeout error for the given operation and timeout duration.

traverse_errors(error_or_errors, fun)

Traverses errors, calling fun for each leaf error, and returns a nested map of results grouped by each error's path.

See Splode.traverse_errors/2 for full documentation.

Example

iex> Elixir.Jido.Browser.Error.traverse_errors(error, fn error ->
...>   Exception.message(error)
...> end)
%{name: ["name is required"]}

unwrap!(result, opts \\ nil)

Raises an error if the result is an error, otherwise returns the result

Alternatively, you can use the defsplode macro, which does this automatically.

Options

:error_opts - Options to pass to to_error/2 when converting the returned error
:unknown_error_opts - Options to pass to the unknown error if the function returns only :error. not necessary if your function always returns {:error, error}.

Examples

def function(arg) do

case do_something(arg) do
  :success -> :ok
  {:success, result} -> {:ok, result}
  {:error, error} -> {:error, error}
end

end

def function!(arg) do

YourErrors.unwrap!(function(arg))

end