Cldr.Calendar.first_day_of_year

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

first_day_of_year(map)

Specs

first_day_of_year(date :: Date.t()) :: Date.t()

Returns the first date of a year for a Date.t.

Arguments

date is any Date.t()

Returns

a Date.t() or
{:error, :invalid_date}

Examples

iex>  Cldr.Calendar.first_day_of_year ~D[2019-12-01]
~D[2019-01-01]

first_day_of_year(year, calendar)

Specs

first_day_of_year(year :: Calendar.year(), calendar :: calendar()) :: Date.t()

Returns the first date of a year in a calendar.

Arguments

year is any year
calendar is any module that implements the Calendar and Cldr.Calendar behaviours

Returns

a Date.t() or
{:error, :invalid_date}

Examples

iex> Cldr.Calendar.first_day_of_year 2019, Cldr.Calendar.Gregorian
%Date{calendar: Cldr.Calendar.Gregorian, day: 1, month: 1, year: 2019}

iex> Cldr.Calendar.first_day_of_year 2019, Cldr.Calendar.NRF
%Date{calendar: Cldr.Calendar.NRF, day: 1, month: 1, year: 2019}