API Reference Calendrical v#0.3.1

Calendar functions for calendars compatible with Elixir's Calendar behaviour.

Provides default implementations of the Calendar and Calendrical callbacks for algorithmic calendars.

Implementation of the Thai Buddhist (Buddhist Era) calendar.

Implementation of the Chinese lunisolar calendar.

A composite calendar uses one base calendar before a specified transition date and a different calendar after, optionally chaining multiple transitions to model a sequence of historical calendar reforms.

Implementation of the Coptic calendar.

Computes the dates of Christian ecclesiastical events for a given Gregorian year.

Encapsulates the era information for known CLDR calendars.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Buddhist calendar.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Chinese calendar.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Coptic calendar.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Dangi calendar.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Ethiopic calendar.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Ethiopic_amete_alem calendar.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Hebrew calendar.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Indian calendar.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Islamic calendar.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Islamic_civil calendar.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Islamic_rgsa calendar.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Islamic_tbla calendar.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Islamic_umalqura calendar.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Japanese calendar.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Persian calendar.

Implements a year_of_era/{1, 2} function to return the year of era and the era number for the Calendrical.Era.Roc calendar.

Implementation of the Ethiopic calendar.

Implementation of the Ethiopic calendar with the Amete Alem (Era of the World, Anno Mundi) year numbering.

Pre-built fiscal-year calendars for ISO 3166 territories.

Renders Calendrical calendars as years, months, weeks, and days using a pluggable formatter.

Calendar formatter behaviour.

Exception raised when a value supplied to a calendar formatter is not a recognised date.

Exception raised when an unknown option, or an option with an invalid value, is supplied to a calendar formatter.

Exception raised when a calendar formatter module cannot be resolved.

Gettext backend for the Calendrical library.

Implements the proleptic Gregorian calendar.

Implementation of the Hebrew (Jewish) calendar.

Implements the ISO Week calendar.

Exception raised when an operation is attempted between two dates or datetimes that use incompatible calendars.

Exception raised when two datetimes that should be in the same time zone are not.

Implementation of the Indian National (Saka) calendar.

Constructs and compares date intervals for any Calendrical calendar.

Exception raised when a module is referenced as a calendar but does not implement the Calendar (and Calendrical) behaviour.

Exception raised when two dates or times are not ordered from earlier to later as required by the function being called.

Exception raised when an unknown date format width is supplied to a localization function.

Exception raised when an unknown date part is supplied to a localization function.

Exception raised when an unknown date format type is supplied to a localization function.

Implementation of the tabular Islamic (Hijri) civil calendar.

Implementation of the observational (sighting-based) Islamic calendar.

Implementation of the Saudi Arabian sighting-based Islamic calendar (CLDR :islamic_rgsa).

Implementation of the tabular Islamic (Hijri) calendar based on the astronomical epoch.

Implementation of the Saudi Arabian Umm al-Qura calendar.

Implements the Umm al-Qura calendar for determining the first day of each Hijri month using the astronomical rules documented by R. H. van Gent.

Official Umm al-Qura first-day dates sourced from the dataset maintained by R.H. van Gent (Utrecht University) and cross-referenced against the KACST published tables.

Exception raised when an operation on the Umm al-Qura Islamic calendar references a Hijri year that lies outside the embedded reference data.

Implements the Japanese calendar that is calendrically the same as the proleptic Gregorian calendar but has a different era structure.

Provide K-Day functions for Dates, DateTimes and NaiveDateTimes.

Implementation of the Korean lunisolar calendar.

Implementation of the Japanese lunisolar calendar.

Shared base implementation for Calendrical's lunisolar calendars.

Exception raised when a date or datetime does not have all the fields required by the function being called.

Implements the US National Retail Federation (NRF) calendar.

The present Iranian calendar was legally adopted on 31 March 1925, under the early Pahlavi dynasty. The law said that the first day of the year should be the first day of spring in "the true solar year", "as it has been" ever so. It also fixes the number of days in each month, which previously varied by year with the sidereal zodiac.

Resolves the preferred Calendrical calendar module for a CLDR locale or an ISO 3166 territory.

Implementation of the Republic of China (Minguo) calendar.