MyApp.Cldr.Date.Interval.to_string

You're seeing just the function to_string, go back to MyApp.Cldr.Date.Interval module for more information.
Link to this function

to_string(from, to, options)

View Source

Specs

to_string(Calendar.date(), Calendar.date(), Keyword.t()) ::
  {:ok, String.t()} | {:error, {module(), String.t()}}

Returns a interval formed from two dates as a localised string.

Arguments

  • from is any map that conforms to the Calendar.date type.

  • to is any map that conforms to the Calendar.date type. to must occur on or after from.

  • options is a keyword list of options. The default is [].

Options

  • :format is one of :short, :medium or :long or a specific format type or a string representing of an interval format. The default is :medium.

  • :style supports dfferent formatting styles. The alternatives are :date, :month_and_day, :month and :year_and_month. The default is :date.

  • locale is any valid locale name returned by Cldr.known_locale_names/0 or a Cldr.LanguageTag struct. The default is Elixir.MyApp.Cldr.get_locale/0

  • number_system: a number system into which the formatted date digits should be transliterated

Returns

  • {:ok, string} or

  • {:error, {exception, reason}}

Notes

  • For more information on interval format string see the Cldr.Interval.

  • The available predefined formats that can be applied are the keys of the map returned by Cldr.DateTime.Format.interval_formats("en", :gregorian) where "en" can be replaced by any configuration locale name and :gregorian is the underlying CLDR calendar type.

  • In the case where from and to are equal, a single date is formatted instead of an interval

Examples

iex> MyApp.Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-12-31]
{:ok, "Jan 1 – Dec 31, 2020"}

iex> MyApp.Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-01-12]
{:ok, "Jan 1 – 12, 2020"}

iex> MyApp.Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-01-12],
...> format: :long
{:ok, "Wed, Jan 1 – Sun, Jan 12, 2020"}

iex> MyApp.Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-12-01],
...> format: :long, style: :year_and_month
{:ok, "January – December 2020"}

iex> MyApp.Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-01-12],
...> format: :short
{:ok, "1/1/2020 – 1/12/2020"}

iex> MyApp.Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-01-12],
...> format: :long, locale: "fr"
{:ok, "mer. 1 – dim. 12 janv. 2020"}

iex> MyApp.Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-01-12],
...> format: :long, locale: "th", number_system: :thai
{:ok, "พ. ๑ ม.ค. – อา. ๑๒ ม.ค. ๒๐๒๐"}