Cldr.Calendar.Kday.kday_nearest

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

kday_nearest(date, k)

Specs

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

date is %Date{}, a %DateTime{}, %NaiveDateTime{} or a Rata Die
k is an integer day of the week.

Returns

A %Date{} in 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]