MyApp.Cldr.Territory.from_subdivision_code

You're seeing just the function from_subdivision_code, go back to MyApp.Cldr.Territory module for more information.
Link to this function

from_subdivision_code(subdivision_code, options \\ [locale: MyApp.Cldr.get_locale()])

View Source

Specs

from_subdivision_code(binary(), [{:locale, Cldr.Territory.binary_tag()}]) ::
  {:ok, binary()} | {:error, Cldr.Territory.error()}

Localized string for the given subdivision code. Returns {:ok, String.t} if successful, otherwise {:error, reason}.

  • options are:
    • locale is any configured locale. See MyApp.Cldr.Territory.known_locale_names/0. The default is Cldr.get_locale/0

Example

iex> MyApp.Cldr.Territory.from_subdivision_code("gbcma", locale: "en")
{:ok, "Cumbria"}

iex> MyApp.Cldr.Territory.from_subdivision_code("gbcma", locale: "pl")
{:ok, "Kumbria"}

iex> MyApp.Cldr.Territory.from_subdivision_code("gbcma", locale: "bs")
{:error, {Cldr.UnknownSubdivisionError, "The locale \"bs\" has no translation for \"gbcma\"."}}

iex> MyApp.Cldr.Territory.from_subdivision_code("invalid", locale: "en")
{:error, {Cldr.UnknownTerritoryError, "The territory \"invalid\" is unknown"}}

iex> MyApp.Cldr.Territory.from_subdivision_code("gbcma", [locale: :zzz])
{:error, {Cldr.UnknownLocaleError, "The locale :zzz is not known."}}

iex> MyApp.Cldr.Territory.from_subdivision_code("gbcma", [locale: "zzz"])
{:error, {Cldr.UnknownLocaleError, "The locale \"zzz\" is not known."}}