# `Letterbox.Sweeper`
[🔗](https://github.com/hattoriai/letterbox/blob/v0.1.0-rc.0/lib/letterbox/sweeper.ex#L1)

A process of the app's that keeps Letterbox's table: on start, the
messages that were waiting go to the runner again (`Letterbox.resume/1`);
then, every hour, those done with for `:incinerate_after` days are
deleted (`Letterbox.incinerate/1`).

    children = [
      MyApp.Repo,
      {Letterbox.Sweeper, incinerate_after: 30}
    ]

After the repo, in the app's supervision tree. Options:
`:incinerate_after` (days; nil keeps every message), `:every` (an hour,
in milliseconds) and `:resume` (`true`).

With Oban, an app can do the same in a cron job of its own and run no
sweeper.

# `child_spec`

Returns a specification to start this module under a supervisor.

See `Supervisor`.

---

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