# `Filtrex.Condition.DateTime`
[🔗](https://github.com/rcdilorenzo/filtrex/blob/main/lib/filtrex/conditions/datetime.ex#L1)

`Filtrex.Condition.DateTime` is a specific condition type for handling datetime filters with various comparisons.

Configuration Options:

| Key    | Type    | Description                                                    |
|--------|---------|----------------------------------------------------------------|
| format | string  | the format* to use for parsing the incoming date string      |
|        |         | (defaults to {ISOz} and can use any valid Timex format)        |

\* See https://hexdocs.pm/timex/Timex.Format.DateTime.Formatters.Default.html

There are three different value formats allowed based on the type of comparator:

| Key        | Type    | Format / Allowed Values                   |
|------------|---------|-------------------------------------------|
| inverse    | boolean | See `Filtrex.Condition.Text`              |
| column     | string  | any allowed keys from passed `config`     |
| comparator | string  | after, on or after, before, on or before,|
|            |         | equals, does not equal                    |
| value      | string  | "YYYY-MM-DD'T'HH:MM:ss.SSS'Z'" ({ISOz})   |
| type       | string  | "datetime"                                |

# `comparators`

# `parse`

# `type`

---

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