# `Hunter.FilterKeyword`
[🔗](https://github.com/milmazz/hunter/blob/v0.8.0/lib/hunter/filter_keyword.ex#L1)

FilterKeyword entity

A keyword that, if matched, should cause the filter action to be taken,
part of `Hunter.Filter`

## Fields

  * `id` - the ID of the filter keyword
  * `keyword` - the phrase to be matched against
  * `whole_word` - whether the keyword should consider word boundaries

# `t`

```elixir
@type t() :: %Hunter.FilterKeyword{
  id: String.t(),
  keyword: String.t(),
  whole_word: boolean()
}
```

---

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