Cldr.Date.Interval.to_string
to_string
, go back to Cldr.Date.Interval module for more information.
Specs
to_string(Cldr.Interval.range(), Cldr.backend(), Keyword.t()) :: {:ok, String.t()} | {:error, {module(), String.t()}}
Returns a Date.Range
or CalendarInterval
as
a localised string.
Arguments
range
is either aDate.Range.t
returned fromDate.range/2
or aCalendarInterval.t
backend
is any module that includesuse Cldr
and is therefore anCldr
backend moduleoptions
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 byCldr.known_locale_names/0
or aCldr.LanguageTag
struct. The default isCldr.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
CalendarInterval
support requires adding the dependency calendar_interval to thedeps
configuration inmix.exs
.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 underlyingCLDR
calendar type.In the case where
from
andto
are equal, a single date is formatted instead of an interval
Examples
iex> Cldr.Date.Interval.to_string Date.range(~D[2020-01-01], ~D[2020-12-31]), MyApp.Cldr
{:ok, "Jan 1 – Dec 31, 2020"}
iex> Cldr.Date.Interval.to_string Date.range(~D[2020-01-01], ~D[2020-01-12]), MyApp.Cldr
{:ok, "Jan 1 – 12, 2020"}
iex> Cldr.Date.Interval.to_string Date.range(~D[2020-01-01], ~D[2020-01-12]), MyApp.Cldr,
...> format: :long
{:ok, "Wed, Jan 1 – Sun, Jan 12, 2020"}
iex> Cldr.Date.Interval.to_string Date.range(~D[2020-01-01], ~D[2020-12-01]), MyApp.Cldr,
...> format: :long, style: :year_and_month
{:ok, "January – December 2020"}
iex> use CalendarInterval
iex> Cldr.Date.Interval.to_string ~I"2020-01/12", MyApp.Cldr
{:ok, "Jan 1 – Dec 31, 2020"}
iex> Cldr.Date.Interval.to_string Date.range(~D[2020-01-01], ~D[2020-01-12]), MyApp.Cldr,
...> format: :short
{:ok, "1/1/2020 – 1/12/2020"}
iex> Cldr.Date.Interval.to_string Date.range(~D[2020-01-01], ~D[2020-01-12]), MyApp.Cldr,
...> format: :long, locale: "fr"
{:ok, "mer. 1 – dim. 12 janv. 2020"}
Specs
to_string( Calendar.date() | nil, Calendar.date() | nil, Cldr.backend(), Keyword.t() ) :: {:ok, String.t()} | {:error, {module(), String.t()}}
Returns a localised string representing the formatted interval formed by two dates.
Arguments
from
is any map that conforms to theCalendar.date
type.to
is any map that conforms to theCalendar.date
type.to
must occur on or afterfrom
.backend
is any module that includesuse Cldr
and is therefore anCldr
backend moduleoptions
is a keyword list of options. The default is[]
.
Either from
or to
may also be nil
in which case the
interval is formatted as an open interval with the non-nil
side formatted as a standalone date.
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 byCldr.known_locale_names/0
or aCldr.LanguageTag
struct. The default isCldr.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 underlyingCLDR
calendar type.In the case where
from
andto
are equal, a single date is formatted instead of an interval
Examples
iex> Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-12-31], MyApp.Cldr
{:ok, "Jan 1 – Dec 31, 2020"}
iex> Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-01-12], MyApp.Cldr
{:ok, "Jan 1 – 12, 2020"}
iex> Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-01-12], MyApp.Cldr,
...> format: :long
{:ok, "Wed, Jan 1 – Sun, Jan 12, 2020"}
iex> Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-12-01], MyApp.Cldr,
...> format: :long, style: :year_and_month
{:ok, "January – December 2020"}
iex> Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-01-12], MyApp.Cldr,
...> format: :short
{:ok, "1/1/2020 – 1/12/2020"}
iex> Cldr.Date.Interval.to_string ~D[2020-01-01], nil, MyApp.Cldr,
...> format: :short
{:ok, "1/1/20 –"}
iex> Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-01-12], MyApp.Cldr,
...> format: :long, locale: "fr"
{:ok, "mer. 1 – dim. 12 janv. 2020"}
iex> Cldr.Date.Interval.to_string ~D[2020-01-01], ~D[2020-01-12], MyApp.Cldr,
...> format: :long, locale: "th", number_system: :thai
{:ok, "พ. ๑ ม.ค. – อา. ๑๒ ม.ค. ๒๐๒๐"}