LivePhone.Country (live_phone v0.1.1) View Source

The LivePhone.Country struct holds minimal information about a country, but it should be enough data for LivePhone to work it's magic.

Link to this section Summary

Types

t()

Functions

from_iso(arg)

Converts the given iso_country tuple into a LivePhone.Country struct.

Link to this section Types

t()

Specs

t() :: %LivePhone.Country{
  code: String.t(),
  flag_emoji: String.t(),
  name: String.t(),
  preferred: boolean(),
  region_code: String.t()
}

Link to this section Functions

from_iso(arg)

Specs

from_iso({String.t(), %{required(String.t()) => String.t()}}) :: t()

Converts the given iso_country tuple into a LivePhone.Country struct.

Examples

iex> ISO.countries() |> Map.to_list() |> List.first() |> LivePhone.Country.from_iso()
%LivePhone.Country{
  preferred: false,
  region_code: "232",
  flag_emoji: "🇸🇱",
  code: "SL",
  name: "Sierra Leone"
}

iex> LivePhone.Country.from_iso({"US", %{"name" => "United States"}})
%LivePhone.Country{
  preferred: false,
  region_code: "1",
  flag_emoji: "🇺🇸",
  code: "US",
  name: "United States"
}