Cldr.Currency.display_name

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

display_name(currency, options \\ [])

Specs

display_name(t() | code(), Keyword.t()) ::
  {:ok, String.t()} | {:error, {module(), String.t()}}

Return the display name for a currency.

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

{:ok, display_name}
or {:error, {exception, reason}}

Examples

iex> Cldr.Currency.display_name :AUD, backend: MyApp.Cldr
{:ok, "Australian Dollar"}

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

iex> Cldr.Currency.display_name "EUR", backend: MyApp.Cldr, locale: "de"
{:ok, "Euro"}

iex> Cldr.Currency.display_name "ZZZ", backend: MyApp.Cldr
{:error, {Cldr.UnknownCurrencyError, "The currency \"ZZZ\" is invalid"}}