@spec of(String.t() | atom(), Keyword.t()) :: {:ok, String.t()} | {:error, term()}

Returns the localized display name for the given code.

Arguments

• code is a string or atom identifying the entity (for example, "US" for a region, "fr" for a language, or "EUR" for a currency).

• options is a keyword list of options.

Options

• :type is a required option. One of :region, :language, :currency, :script, :calendar, or :date_time_field.

• :locale is a locale identifier string or atom. The default is the current process locale.

• :style is :standard, :short, :long, :menu, or :variant where applicable. The default varies by type.

Returns

• {:ok, display_name} on success.

• {:error, reason} if the code or type is invalid.

Examples

iex> Intl.DisplayNames.of("US", type: :region, locale: :en)
{:ok, "United States"}

iex> Intl.DisplayNames.of("fr", type: :language, locale: :en)
{:ok, "French"}

iex> Intl.DisplayNames.of("EUR", type: :currency, locale: :en)
{:ok, "Euro"}

iex> Intl.DisplayNames.of(:Latn, type: :script, locale: :en)
{:ok, "Latin"}

iex> Intl.DisplayNames.of(:gregorian, type: :calendar, locale: :en)
{:ok, "Gregorian Calendar"}

iex> Intl.DisplayNames.of(:year, type: :date_time_field, locale: :en)
{:ok, "year"}

@spec of!(String.t() | atom(), Keyword.t()) :: String.t() | no_return()

Returns the localized display name, raising on error.

Same as of/2 but returns the string directly or raises.

Arguments

• code is a string or atom identifying the entity.

• options is a keyword list of options.

Returns

• A display name string.

Examples

iex> Intl.DisplayNames.of!("US", type: :region, locale: :en)
"United States"