# `FaktoryWorker.Sandbox`
[🔗](https://github.com/opt-elixir/faktory_worker/blob/main/lib/faktory_worker/sandbox.ex#L1)

When started with sandbox mode enabled, `FaktoryWorker` won't connect
to a running Faktory instance or perform queued jobs, but will instead
record all jobs enqueued locally.

In general, this mode should only be used during testing. See
[Sandbox Testing](sandbox-testing.html) to read more.

# `job`

```elixir
@type job() :: %{worker: module(), args: list(), opts: Keyword.t()}
```

A concise description of a single call to a job module.

# `active?`

```elixir
@spec active?() :: boolean()
```

Returns true if sandbox mode is enabled.

# `all_jobs`

```elixir
@spec all_jobs() :: [job()]
```

Returns a list of all locally enqueued jobs across all job modules, in
the order that they were enqueued. If you only want to retrieve jobs
enqueued for a specific job module, use `all_jobs/1` instead.

# `all_jobs`

```elixir
@spec all_jobs(module()) :: [job()]
```

Returns a list of all locally enqueued jobs for the given job module,
in the order that they were enqueued. If you want to retrieve a list of
all jobs across all job modules, use `all_jobs/0` instead.

# `batch_id`

# `batch_status`

# `child_spec`

Returns a specification to start this module under a supervisor.

See `Supervisor`.

# `reset`

```elixir
@spec reset() :: :ok
```

Clear the queue history for all job modules.

# `reset`

```elixir
@spec reset(module()) :: :ok
```

Clear the queue history for the given job module.

---

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