Cldr.Calendar.iso_week_of_year

You're seeing just the function iso_week_of_year, go back to Cldr.Calendar module for more information.

Specs

iso_week_of_year(Date.t()) :: {Calendar.year(), week()}

Returns the ISO week number for a date.

Arguments

  • date is any Date.t()

Returns

  • a the ISO week of the year as an integer or

  • {:error, :not_defined} is the calendar does not support the concept of weeks.

Examples

iex> Cldr.Calendar.iso_week_of_year ~D[2019-01-01]
{2019, 1}
iex> Cldr.Calendar.iso_week_of_year ~D[2019-02-01]
{2019, 5}
iex> Cldr.Calendar.iso_week_of_year ~D[2019-52-01 Cldr.Calendar.NRF]
{2020, 4}
iex> Cldr.Calendar.iso_week_of_year ~D[2019-26-01 Cldr.Calendar.NRF]
{2019, 30}
iex> Cldr.Calendar.iso_week_of_year ~D[2019-12-01 Cldr.Calendar.Julian]
{:error, :not_defined}