Cldr.Currency.display_name-exclamation-mark

You're seeing just the function display_name-exclamation-mark, go back to Cldr.Currency module for more information.

display_name!(currency, options \\ [])

Specs

display_name!(t() | code(), Keyword.t()) :: String.t() | no_return()

Return the display name for a currency or raises and exception on error.

The display name is useful for UI uses, for example in menus. The display name is typically capitalized for stand-alone use where as the display name returned by Cldr.Currency.pluralize/4 is typically lower-cased for use within sentences.

Arguments

currency is any currency code returned by Cldr.Currency.known_currencies/0 or a t:Cldr.Currency struct returned by Cldr.Currency.currency_for_code/3

Options

:locale is any locale returned by Cldr.Locale.new!/2. The default is Cldr.get_locale/0
:backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend!/0

Returns

display_name
or raises an exception

Examples

iex> Cldr.Currency.display_name! :AUD, backend: MyApp.Cldr
"Australian Dollar"

iex> Cldr.Currency.display_name! "AUD", backend: MyApp.Cldr, locale: "fr"
"dollar australien"

iex> Cldr.Currency.display_name! "EUR", backend: MyApp.Cldr, locale: "de"
"Euro"

#=> Cldr.Currency.display_name! "ZZZ", backend: MyApp.Cldr
** (Cldr.UnknownCurrencyError) The currency "ZZZ" is invalid