Cocktail.Parser.ICalendar.parse
You're seeing just the function
parse
, go back to Cocktail.Parser.ICalendar module for more information.
Specs
parse(String.t()) :: {:ok, Cocktail.Schedule.t()} | {:error, term()}
Parses a string in iCalendar format into a Cocktail.Schedule.t/0
.
Examples
iex> {:ok, schedule} = parse("DTSTART;TZID=America/Los_Angeles:20170810T160000\nRRULE:FREQ=DAILY;INTERVAL=2")
...> schedule
#Cocktail.Schedule<Every 2 days>
iex> {:ok, schedule} = parse("DTSTART;TZID=America/Los_Angeles:20170810T160000\nRRULE:FREQ=WEEKLY")
...> schedule
#Cocktail.Schedule<Weekly>
iex> {:ok, schedule} = parse("DTSTART;TZID=America/Los_Angeles:20170810T160000\nRRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR")
...> schedule
#Cocktail.Schedule<Weekly on Mondays, Wednesdays and Fridays>
iex> {:ok, schedule} = parse("DTSTART;TZID=America/Los_Angeles:20170810T160000\nRRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,WE,FR;BYHOUR=10,12,14")
...> schedule
#Cocktail.Schedule<Every 2 weeks on Mondays, Wednesdays and Fridays on the 10th, 12th and 14th hours of the day>