# `VulnCheck.Types.Retirement`
[🔗](https://github.com/Voskan/vulncheck/blob/v1.0.1/lib/vulncheck/types/advisory.ex#L26)

Hex.pm retirement metadata attached to a specific package release.

# `reason`

```elixir
@type reason() :: :security | :invalid | :deprecated | :renamed | :other
```

# `t`

```elixir
@type t() :: %VulnCheck.Types.Retirement{
  message: String.t(),
  package: String.t(),
  reason: reason(),
  version: String.t()
}
```

---

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