@spec current_locale() :: String.t()

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

@spec get_day_periods(locale :: String.t()) :: %{required(atom()) => String.t()}

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

examples

Examples

iex> day_periods = Timex.Translator.get_day_periods("en")
...> {day_periods[:am], day_periods[:AM]}
{"am", "AM"}

@spec get_months(locale :: String.t()) :: %{required(integer()) => String.t()}

Returns a map of ordinal months to month names

@spec get_months_abbreviated(locale :: String.t()) :: %{
  required(integer()) => String.t()
}

Returns a map of ordinal months to month abbreviations

@spec get_weekdays(locale :: String.t()) :: %{required(integer()) => String.t()}

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

@spec get_weekdays_abbreviated(locale :: String.t()) :: %{
  required(integer()) => String.t()
}

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

@spec translate(locale :: String.t(), domain :: String.t(), msgid :: String.t()) ::
  String.t()

Translates a string for a given locale and domain.

examples

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"

@spec 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

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"