Crontab.CronExpression.Parser (crontab v1.2.0)
View SourceParse string like * * * * * *
to a %Crontab.CronExpression{}
.
Summary
Functions
Parse string like * * * * * *
to a %CronExpression{}
.
Parse string like * * * * * *
to a %CronExpression{}
.
Types
@type result() :: {:ok, Crontab.CronExpression.t()} | {:error, binary()}
Functions
@spec parse(binary(), boolean(), [Crontab.CronExpression.ambiguity_opt()]) :: result()
Parse string like * * * * * *
to a %CronExpression{}
.
Examples
iex> Crontab.CronExpression.Parser.parse("* * * * *")
{:ok,
%Crontab.CronExpression{
day: [:*],
hour: [:*],
minute: [:*],
month: [:*],
weekday: [:*],
year: [:*],
on_ambiguity: []
}}
iex> Crontab.CronExpression.Parser.parse("* * * * *", true)
{:ok,
%Crontab.CronExpression{
extended: true,
day: [:*],
hour: [:*],
minute: [:*],
month: [:*],
weekday: [:*],
year: [:*],
second: [:*],
on_ambiguity: []
}}
iex> Crontab.CronExpression.Parser.parse("fooo")
{:error, "Can't parse fooo as minute."}
@spec parse!(binary(), boolean(), [Crontab.CronExpression.ambiguity_opt()]) :: Crontab.CronExpression.t()
Parse string like * * * * * *
to a %CronExpression{}
.
Examples
iex> Crontab.CronExpression.Parser.parse!("* * * * *")
%Crontab.CronExpression{
day: [:*],
hour: [:*],
minute: [:*],
month: [:*],
weekday: [:*],
year: [:*],
on_ambiguity: []
}
iex> Crontab.CronExpression.Parser.parse!("* * * * *", true)
%Crontab.CronExpression{
extended: true,
day: [:*],
hour: [:*],
minute: [:*],
month: [:*],
weekday: [:*],
year: [:*],
second: [:*],
on_ambiguity: []
}
iex> Crontab.CronExpression.Parser.parse!("fooo")
** (RuntimeError) Can't parse fooo as minute.