timex v3.2.0 Timex.Translator View Source

Link to this section Summary

Functions

Returns the active locale for the process in which this function is called

Returns the currently configured default locale. If not set, “en” is used

Returns a map of day period types to translated day period names

Returns a map of ordinal months to month names

Returns a map of ordinal months to month abbreviations

Returns a map of ordinal weekdays to weekday names, where Monday = 1, translated in the given locale

Returns a map of ordinal weekdays to weekday abbreviations, where Mon = 1

Translates a string for a given locale and domain

Translates a string for a given locale and domain, following the pluralization rules of that language

This macro sets the locale during execution of a given block of code

Link to this section Functions

Link to this function current_locale() View Source
current_locale() :: String.t()

Returns the active locale for the process in which this function is called

Link to this function default_locale() View Source
default_locale() :: String.t()

Returns the currently configured default locale. If not set, “en” is used.

Link to this function get_day_periods(locale) View Source
get_day_periods(locale :: String.t()) :: %{optional(atom()) => String.t()}

Returns a map of day period types to translated day period names

Examples

iex> day_periods = Timex.Translator.get_day_periods("en")
...> {day_periods[:am], day_periods[:AM]}
{"am", "AM"}
Link to this function get_months(locale) View Source
get_months(locale :: String.t()) :: %{optional(integer()) => String.t()}

Returns a map of ordinal months to month names

Link to this function get_months_abbreviated(locale) View Source
get_months_abbreviated(locale :: String.t()) :: %{
  optional(integer()) => String.t()
}

Returns a map of ordinal months to month abbreviations

Link to this function get_weekdays(locale) View Source
get_weekdays(locale :: String.t()) :: %{optional(integer()) => String.t()}

Returns a map of ordinal weekdays to weekday names, where Monday = 1, translated in the given locale

Link to this function get_weekdays_abbreviated(locale) View Source
get_weekdays_abbreviated(locale :: String.t()) :: %{
  optional(integer()) => String.t()
}

Returns a map of ordinal weekdays to weekday abbreviations, where Mon = 1

Link to this function translate(locale, domain, msgid) View Source
translate(locale :: String.t(), domain :: String.t(), msgid :: String.t()) ::
  String.t()

Translates a string for a given locale and domain.

Examples

iex> Timex.Translator.translate("ru", "weekdays", "Saturday")
"суббота"

iex> Timex.Translator.translate("it", "weekdays", "Saturday")
"Sabato"

iex> Timex.Translator.translate("invalid_locale", "weekdays", "Saturday")
"Saturday"
Link to this function translate_plural(locale, domain, msgid, msgid_plural, n) View Source
translate_plural(
  locale :: String.t(),
  domain :: String.t(),
  msgid :: String.t(),
  msgid_plural :: String.t(),
  n :: integer()
) :: String.t()

Translates a string for a given locale and domain, following the pluralization rules of that language.

Examples

iex> Timex.Translator.translate_plural("ru", "relative_time", "in %{count} second", "in %{count} seconds", 5)
"через 5 секунд"

iex> Timex.Translator.translate_plural("it", "relative_time", "in %{count} second", "in %{count} seconds", 5)
"in 5 secondi"

iex> Timex.Translator.translate_plural("invalid_locale", "relative_time", "in %{count} second", "in %{count} seconds", 5)
"in 5 seconds"
Link to this macro with_locale(locale, list) View Source (macro)

This macro sets the locale during execution of a given block of code.