View Source Cldr.Calendar.Kday (Cldr Calendars v1.23.1)
Provide K-Day functions for Dates, DateTimes and NaiveDateTimes.
Summary
Functions
Return the date of the first day_of_week on or after the
specified date.
Return the date of the day_of_week after the
specified date.
Return the date of the day_of_week before the
specified date.
Return the date of the day_of_week nearest the
specified date.
Return the date of the day_of_week on or after the
specified date.
Return the date of the day_of_week on or before the
specified date.
Return the date of the last day_of_week on or before the
specified date.
Return the date of the nth day_of_week on or before/after the
specified date.
Functions
@spec first_kday(Calendar.day() | Date.t(), Cldr.Calendar.day_of_week()) :: Calendar.day() | Date.t()
Return the date of the first day_of_week on or after the
specified date.
Arguments
dateisDate.t/0, aDateTime.t/0,NaiveDateTime.t/0or ISO days since epoch.kis an integer day of the week where1is Monday and7is Sunday.
Returns
- A
Date.t/0in the calendar of the date provided as an argument.
Examples
# US election day
iex> Cldr.Calendar.Kday.first_kday(~D[2017-11-02], 2)
~D[2017-11-07]
# US Daylight savings end
iex> Cldr.Calendar.Kday.first_kday(~D[2017-11-01], 7)
~D[2017-11-05]@spec kday_after(Calendar.day() | Date.t(), Cldr.Calendar.day_of_week()) :: Calendar.day() | Date.t()
Return the date of the day_of_week after the
specified date.
Arguments
dateisDate.t/0, aDateTime.t/0,NaiveDateTime.t/0or ISO days since epoch.kis an integer day of the week where1is Monday and7is Sunday.
Returns
- A
Date.t/0in the calendar of the date provided as an argument.
Examples
iex> Cldr.Calendar.Kday.kday_after(~D[2016-02-29], 2)
~D[2016-03-01]
iex> Cldr.Calendar.Kday.kday_after(~D[2017-11-30], 1)
~D[2017-12-04]
iex> Cldr.Calendar.Kday.kday_after(~D[2017-06-30], 6)
~D[2017-07-01]
iex> Cldr.Calendar.Kday.kday_after(~D[2021-03-28], 7)
~D[2021-04-04]@spec kday_before(Calendar.day() | Date.t(), Cldr.Calendar.day_of_week()) :: Calendar.day() | Date.t()
Return the date of the day_of_week before the
specified date.
Arguments
dateisDate.t/0, aDateTime.t/0,NaiveDateTime.t/0or ISO days since epoch.kis an integer day of the week where1is Monday and7is Sunday.
Returns
- A
Date.t/0in the calendar of the date provided as an argument.
Examples
iex> Cldr.Calendar.Kday.kday_before(~D[2016-02-29], 2)
~D[2016-02-23]
iex> Cldr.Calendar.Kday.kday_before(~D[2017-11-30], 1)
~D[2017-11-27]
iex> Cldr.Calendar.Kday.kday_before(~D[2023-09-30], 5)
~D[2023-09-29]
# 6 means Saturday. Use either the integer value or the atom form.
iex> Cldr.Calendar.Kday.kday_before(~D[2017-06-30], 6)
~D[2017-06-24]@spec kday_nearest(Calendar.day() | Date.t(), Cldr.Calendar.day_of_week()) :: Calendar.day() | Date.t()
Return the date of the day_of_week nearest the
specified date.
Arguments
dateisDate.t/0, aDateTime.t/0,NaiveDateTime.t/0or ISO days since epoch.kis an integer day of the week where1is Monday and7is Sunday.
Returns
- A
Date.t/0in the calendar of the date provided as an argument.
Examples
iex> Cldr.Calendar.Kday.kday_nearest(~D[2016-02-29], 2)
~D[2016-03-01]
iex> Cldr.Calendar.Kday.kday_nearest(~D[2017-11-30], 1)
~D[2017-11-27]
iex> Cldr.Calendar.Kday.kday_nearest(~D[2017-06-30], 6)
~D[2017-07-01]@spec kday_on_or_after(Calendar.day() | Date.t(), Cldr.Calendar.day_of_week()) :: Calendar.day() | Date.t()
Return the date of the day_of_week on or after the
specified date.
Arguments
dateisDate.t/0, aDateTime.t/0,NaiveDateTime.t/0or ISO days since epoch.kis an integer day of the week where1is Monday and7is Sunday.
Returns
- A
Date.t/0in the calendar of the date provided as an argument
Examples
iex> Cldr.Calendar.Kday.kday_on_or_after(~D[2016-02-29], 2)
~D[2016-03-01]
iex> Cldr.Calendar.Kday.kday_on_or_after(~D[2017-11-30], 1)
~D[2017-12-04]
iex> Cldr.Calendar.Kday.kday_on_or_after(~D[2017-06-30], 6)
~D[2017-07-01]
iex> Cldr.Calendar.Kday.kday_on_or_after(~D[2023-09-29], 5)
~D[2023-09-29]@spec kday_on_or_before(Calendar.day() | Date.t(), Cldr.Calendar.day_of_week()) :: Calendar.day() | Date.t()
Return the date of the day_of_week on or before the
specified date.
Arguments
dateisDate.t/0, aDateTime.t/0,NaiveDateTime.t/0or ISO days since epoch.kis an integer day of the week where1is Monday and7is Sunday.
Returns
- A
Date.t/0in the calendar of the date provided as an argument.
Examples
iex> Cldr.Calendar.Kday.kday_on_or_before(~D[2016-02-29], 2)
~D[2016-02-23]
iex> Cldr.Calendar.Kday.kday_on_or_before(~D[2017-11-30], 1)
~D[2017-11-27]
iex> Cldr.Calendar.Kday.kday_on_or_before(~D[2017-06-30], 6)
~D[2017-06-24]
iex> Cldr.Calendar.Kday.kday_on_or_before(~D[2023-09-29], 5)
~D[2023-09-29]@spec last_kday(Calendar.day() | Date.t(), Cldr.Calendar.day_of_week()) :: Calendar.day() | Date.t()
Return the date of the last day_of_week on or before the
specified date.
Arguments
dateisDate.t/0, aDateTime.t/0,NaiveDateTime.t/0or ISO days since epoch.kis an integer day of the week where1is Monday and7is Sunday.
Returns
- A
Date.t/0in the calendar of the date provided as an argument
Example
# Memorial Day in the US
iex> Cldr.Calendar.Kday.last_kday(~D[2017-05-31], 1)
~D[2017-05-29]@spec nth_kday(Calendar.day() | Date.t(), integer(), Cldr.Calendar.day_of_week()) :: Calendar.day() | Date.t()
Return the date of the nth day_of_week on or before/after the
specified date.
Arguments
dateisDate.t/0, aDateTime.t/0,NaiveDateTime.t/0or ISO days since epoch.nis the cardinal number ofkbefore (negativen) or after (positiven) the specified date.kis an integer day of the week where1is Monday and7is Sunday.
Returns
- A
Date.t/0in the calendar of the date provided as an argument.
Examples
# Thanksgiving in the US
iex> Cldr.Calendar.Kday.nth_kday(~D[2017-11-01], 4, 4)
~D[2017-11-23]
# Labor day in the US
iex> Cldr.Calendar.Kday.nth_kday(~D[2017-09-01], 1, 1)
~D[2017-09-04]
# Daylight savings time starts in the US
iex> Cldr.Calendar.Kday.nth_kday(~D[2017-03-01], 2, 7)
~D[2017-03-12]