crontab v1.1.10 Crontab.DateChecker View Source

This Module is used to check a CronExpression against a given date.

Link to this section Summary

Functions

Check a condition list against a given date.

Check a condition against a given date.

Link to this section Functions

Link to this function

matches_date?(cron_expression_or_condition_list, date)

View Source
matches_date?(
  cron_expression :: Crontab.CronExpression.t(),
  date :: NaiveDateTime.t()
) :: boolean() | no_return()
matches_date?(
  condition_list :: Crontab.CronExpression.condition_list(),
  date :: NaiveDateTime.t()
) :: boolean()

Check a condition list against a given date.

Examples

iex> Crontab.DateChecker.matches_date? %Crontab.CronExpression{minute: [{:"/", :*, 8}]}, ~N[2004-04-16 04:08:08]
true

iex> Crontab.DateChecker.matches_date? %Crontab.CronExpression{minute: [{:"/", :*, 9}]}, ~N[2004-04-16 04:07:08]
false

iex> Crontab.DateChecker.matches_date? %Crontab.CronExpression{reboot: true}, ~N[2004-04-16 04:07:08]
** (RuntimeError) Special identifier @reboot is not supported.

iex> Crontab.DateChecker.matches_date? [{:hour, [{:"/", :*, 4}, 7]}], ~N[2004-04-16 04:07:08]
true

Check a condition against a given date.

Examples

iex> Crontab.DateChecker.matches_date? :hour, [{:"/", :*, 4}, 7], ~N[2004-04-16 04:07:08]
true

iex> Crontab.DateChecker.matches_date? :hour, [8], ~N[2004-04-16 04:07:08]
false