crontab v1.1.13

View Source Crontab.CronExpression (crontab v1.1.13)

The Crontab.CronExpression module / struct.

Link to this section Summary

Types

condition()
condition(name, time_unit)
condition_list()
day() deprecated
hour() deprecated
interval()
min_max() deprecated
min_max(time_unit)
minute() deprecated
month() deprecated
second() deprecated
t()
time_unit() deprecated
value()
value(time_unit)
weekday() deprecated
year() deprecated

Functions

%Crontab.CronExpression{}

Defines the Cron interval.

sigil_e(cron_expression, options)

Create a %Crontab.CronExpression{} via sigil.

to_condition_list(interval)

Convert Crontab.CronExpression struct to tuple List.

Link to this section Types

Link to this type

condition()

View Source 
@type condition() ::
  condition(:second, Calendar.second())
  | condition(:minute, Calendar.minute())
  | condition(:hour, Calendar.hour())
  | condition(:day, Calendar.day())
  | condition(:month, Calendar.month())
  | condition(:weekday, Calendar.day_of_week())
  | condition(:year, Calendar.year())
Link to this type

condition(name, time_unit)

View Source 
@type condition(name, time_unit) :: {name, [value(time_unit)]}
Link to this type

condition_list()

View Source 
@type condition_list() :: [condition()]
Link to this type

day()

View Source
This type is deprecated. Use Calendar.day/0 instead. 
@type day() :: Calendar.day()
Link to this type

hour()

View Source
This type is deprecated. Use Calendar.hour/0 instead. 
@type hour() :: Calendar.hour()
Link to this type

interval()

View Source 
@type interval() :: :second | :minute | :hour | :day | :month | :weekday | :year
Link to this type

min_max()

View Source
This type is deprecated. Use Crontab.CronExpression.min_max/1 instead. 
@type min_max() :: {:-, time_unit(), time_unit()}
Link to this type

min_max(time_unit)

View Source 
@type min_max(time_unit) :: {:-, time_unit, time_unit}
Link to this type

minute()

View Source
This type is deprecated. Use Calendar.minute/0 instead. 
@type minute() :: Calendar.minute()
Link to this type

month()

View Source
This type is deprecated. Use Calendar.month/0 instead. 
@type month() :: Calendar.month()
Link to this type

second()

View Source
This type is deprecated. Use Calendar.second/0 instead. 
@type second() :: Calendar.second()
Link to this type

t()

View Source 
@type t() :: %Crontab.CronExpression{
  day: [value(day())],
  extended: boolean(),
  hour: [value(hour())],
  minute: [value(minute())],
  month: [value(month())],
  reboot: boolean(),
  second: [value(second())],
  weekday: [value(weekday())],
  year: [value(year())]
}
Link to this type

time_unit()

View Source
This type is deprecated. Use Calendar.[second|minute|hour|day|month|day_of_week|year]/0 instead. 
@type time_unit() ::
  second() | minute() | hour() | day() | month() | weekday() | year()
Link to this type

value()

View Source 
@type value() ::
  value(Calendar.second())
  | value(Calendar.minute())
  | value(Calendar.hour())
  | value(Calendar.day())
  | value(Calendar.month())
  | value(Calendar.day_of_week())
  | value(Calendar.year())
Link to this type

value(time_unit)

View Source 
@type value(time_unit) ::
  time_unit
  | :*
  | :L
  | {:L, value(time_unit)}
  | {:/, time_unit | :* | min_max(time_unit), pos_integer()}
  | min_max(time_unit)
  | {:W, time_unit | :L}
Link to this type

weekday()

View Source
This type is deprecated. Use Calendar.day_of_week/0 instead. 
@type weekday() :: Calendar.day_of_week()
Link to this type

year()

View Source
This type is deprecated. Use Calendar.year/0 instead. 
@type year() :: Calendar.year()

Link to this section Functions

Link to this function

%Crontab.CronExpression{}

View Source (struct)

Defines the Cron interval.

* * * * * * *
| | | | | | |
| | | | | | +-- :year Year                 (range: 1900-3000)
| | | | | +---- :weekday Day of the Week   (range: 1-7, 1 standing for Monday)
| | | | +------ :month Month of the Year   (range: 1-12)
| | | +-------- :day Day of the Month      (range: 1-31)
| | +---------- :hour Hour                 (range: 0-23)
| +------------ :minute Minute             (range: 0-59)
+-------------- :second Second             (range: 0-59)

The :extended attribute defines if the second is taken into account.

Link to this function

sigil_e(cron_expression, options)

View Source 
@spec sigil_e(
  binary(),
  charlist()
) :: t()

Create a %Crontab.CronExpression{} via sigil.

examples

 Examples 

iex> ~e[*]
%Crontab.CronExpression{
  extended: false,
  second: [:*],
  minute: [:*],
  hour: [:*],
  day: [:*],
  month: [:*],
  weekday: [:*],
  year: [:*]}

iex> ~e[*]e
%Crontab.CronExpression{
  extended: true,
  second: [:*],
  minute: [:*],
  hour: [:*],
  day: [:*],
  month: [:*],
  weekday: [:*],
  year: [:*]}

iex> ~e[1 2 3 4 5 6 7]e
%Crontab.CronExpression{
  extended: true,
  second: [1],
  minute: [2],
  hour: [3],
  day: [4],
  month: [5],
  weekday: [6],
  year: [7]}
Link to this function

to_condition_list(interval)

View Source 
@spec to_condition_list(t()) :: condition_list()

Convert Crontab.CronExpression struct to tuple List.

examples

 Examples 

iex> Crontab.CronExpression.to_condition_list %Crontab.CronExpression{
...> minute: [1], hour: [2], day: [3], month: [4], weekday: [5], year: [6]}
[ {:minute, [1]},
  {:hour, [2]},
  {:day, [3]},
  {:month, [4]},
  {:weekday, [5]},
  {:year, [6]}]

iex> Crontab.CronExpression.to_condition_list %Crontab.CronExpression{
...> extended: true, second: [0], minute: [1], hour: [2], day: [3], month: [4], weekday: [5], year: [6]}
[ {:second, [0]},
  {:minute, [1]},
  {:hour, [2]},
  {:day, [3]},
  {:month, [4]},
  {:weekday, [5]},
  {:year, [6]}]