# `Reactor.Error.Invalid.ForcedFailureError`
[🔗](https://github.com/ash-project/reactor/blob/main/lib/reactor/error/invalid/forced_failure_error.ex/#L6)

This error is returned when the `flunk` DSL entity or the `Reactor.Step.Fail`
step are called.

# `t`

```elixir
@type t() :: %Reactor.Error.Invalid.ForcedFailureError{
  __exception__: true,
  arguments: %{required(atom()) => any()},
  bread_crumbs: term(),
  class: term(),
  context: map(),
  message: String.t(),
  options: keyword(),
  path: term(),
  splode: term(),
  stacktrace: term(),
  step_name: any(),
  vars: term()
}
```

# `exception`

```elixir
@spec exception(opts :: Keyword.t()) :: %Reactor.Error.Invalid.ForcedFailureError{
  __exception__: term(),
  arguments: term(),
  bread_crumbs: term(),
  class: term(),
  context: term(),
  message: term(),
  options: term(),
  path: term(),
  splode: term(),
  stacktrace: term(),
  step_name: term(),
  vars: term()
}
```

Create an `Elixir.Reactor.Error.Invalid.ForcedFailureError` without raising it.

## Keys

- :arguments
- :step_name
- :message
- :context
- :options

---

*Consult [api-reference.md](api-reference.md) for complete listing*