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 any year for calendar

  • week is any week in the year for calendar

  • calendar is any module that implements the Calendar and Cldr.Calendar behaviours. The default is Cldr.Calendar.Gregorian.

Returns

  • A Date.Range.t() representing the the enumerable days in the week 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}
Link to this function

week(year, week, calendar \\ Cldr.Calendar.Gregorian)

View Source

Specs