Cldr.Date.to_string
You're seeing just the function
to_string
, go back to Cldr.Date module for more information.
Link to this function
to_string(date, backend \\ Cldr.Date.default_backend(), options \\ [])
View SourceSpecs
to_string(map(), Cldr.backend() | Keyword.t(), Keyword.t()) :: {:ok, String.t()} | {:error, {module(), String.t()}}
Formats a date according to a format string as defined in CLDR and described in TR35
Arguments
date
is a%Date{}
struct or any map that contains the keysyear
,month
,day
andcalendar
backend
is any module that includesuse Cldr
and therefore is aCldr
backend module. The default isCldr.default_backend/0
.options
is a keyword list of options for formatting. The valid options are:
Options
format:
:short
|:medium
|:long
|:full
or a format string. The default is:medium
locale:
any locale returned byCldr.known_locale_names/1
. The default isCldr.get_locale()
.number_system:
a number system into which the formatted date digits should be transliterated
Returns
{:ok, formatted_string}
or{:error, reason}
Examples
iex> Cldr.Date.to_string ~D[2017-07-10], MyApp.Cldr, format: :medium, locale: "en"
{:ok, "Jul 10, 2017"}
iex> Cldr.Date.to_string ~D[2017-07-10], MyApp.Cldr, locale: "en"
{:ok, "Jul 10, 2017"}
iex> Cldr.Date.to_string ~D[2017-07-10], MyApp.Cldr, format: :full, locale: "en"
{:ok, "Monday, July 10, 2017"}
iex> Cldr.Date.to_string ~D[2017-07-10], MyApp.Cldr, format: :short, locale: "en"
{:ok, "7/10/17"}
iex> Cldr.Date.to_string ~D[2017-07-10], MyApp.Cldr, format: :short, locale: "fr"
{:ok, "10/07/2017"}
iex> Cldr.Date.to_string ~D[2017-07-10], MyApp.Cldr, style: :long, locale: "af"
{:ok, "10 Julie 2017"}