Cldr.Calendar.Interval.week
You're seeing just the function
week
, go back to Cldr.Calendar.Interval module for more information.
Specs
week(Date.t()) :: Date.Range.t()
Returns a Date.Range.t
that represents
the year
.
The range is enumerable.
Arguments
year
is anyyear
forcalendar
week
is anyweek
in theyear
forcalendar
calendar
is any module that implements theCalendar
andCldr.Calendar
behaviours. The default isCldr.Calendar.Gregorian
.
Returns
A
Date.Range.t()
representing the the enumerable days in theweek
or{:error, :not_defined}
if the calendar does not support the concept of weeks
Examples
iex> Cldr.Calendar.Interval.week 2019, 52, Cldr.Calendar.Fiscal.US
#DateRange<~D[2019-12-22 Cldr.Calendar.Fiscal.US], ~D[2019-12-28 Cldr.Calendar.Fiscal.US]>
iex> Cldr.Calendar.Interval.week 2019, 52, Cldr.Calendar.NRF
#DateRange<~D[2019-W52-1 Cldr.Calendar.NRF], ~D[2019-W52-7 Cldr.Calendar.NRF]>
iex> Cldr.Calendar.Interval.week 2019, 52, Cldr.Calendar.ISOWeek
#DateRange<~D[2019-W52-1 Cldr.Calendar.ISOWeek], ~D[2019-W52-7 Cldr.Calendar.ISOWeek]>
iex> Cldr.Calendar.Interval.week 2019, 52, Cldr.Calendar.Julian
{:error, :not_defined}
Specs
week(Calendar.year(), Cldr.Calendar.week(), Cldr.Calendar.calendar()) :: Date.Range.t()