Crontab.CronExpression.Composer (crontab v1.2.0)
View SourceGenerate from %CronExpression{} to * * * * * *.
Summary
Functions
Generate from %Crontab.CronExpression{} to * * * * * *.
Types
@type opts() :: [{:skip_year, boolean()}]
Functions
@spec compose(Crontab.CronExpression.t(), opts()) :: binary()
Generate from %Crontab.CronExpression{} to * * * * * *.
Available options:
- skip_year: boolean
If set to
true, do not add the year to the expression. This means that%Crontab.CronExpression{}will return* * * * *.
Examples
iex> Crontab.CronExpression.Composer.compose(%Crontab.CronExpression{})
"* * * * * *"
iex> Crontab.CronExpression.Composer.compose(%Crontab.CronExpression{
...> minute: [9, {:-, 4, 6}, {:/, :*, 9}]
...> })
"9,4-6,*/9 * * * * *"
iex> Crontab.CronExpression.Composer.compose(%Crontab.CronExpression{reboot: true})
"@reboot"
iex> Crontab.CronExpression.Composer.compose(%Crontab.CronExpression{}, skip_year: true)
"* * * * *"
iex> Crontab.CronExpression.Composer.compose(
...> %Crontab.CronExpression{minute: [9, {:-, 4, 6}, {:/, :*, 9}]},
...> skip_year: true
...> )
"9,4-6,*/9 * * * *"