Cldr.DateTime.Formatter.hour

You're seeing just the function hour, go back to Cldr.DateTime.Formatter module for more information.

hour(hour, n \\ 1, options \\ [])

Specs

hour(Calendar.time(), integer(), Keyword.t()) ::
  String.t() | {:error, String.t()}

Returns the hour formatted in a locale-specific format

Arguments

time is a Time struct or any map that contains at least the key :hour
n is the number of digits to which :hour is padded
locale is any valid locale name returned by Cldr.known_locale_names/0 or a Cldr.LanguageTag struct. The default is Cldr.get_locale/0
options is a Keyword list of options. There are no options used in hour/4

Examples

iex> Cldr.DateTime.Formatter.hour ~N[2020-04-25 15:00:00.0]
"3"

iex> Cldr.DateTime.Formatter.hour ~N[2020-04-25 15:00:00.0], locale: "fr"
"15"

iex> Cldr.DateTime.Formatter.hour ~N[2020-04-25 15:00:00.0], locale: "en-AU"
"3"

iex> Cldr.DateTime.Formatter.hour ~N[2020-04-25 15:00:00.0], locale: "en-AU-u-hc-h23"
"15"

hour(time, n, locale, backend, options \\ [])

Specs

hour(Calendar.time(), integer(), locale(), Cldr.backend(), Keyword.t()) ::
  String.t() | {:error, String.t()}