phone v0.3.1 Phone

Phone is a real telephone number parser, that will help you get useful information from numbers.

How to use

Very simple to use:

iex> Phone.parse("555112345678")
{:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}}

Summary

Functions

Parses a string or integer and returns a map with information about that number

Same as parse/1 but the number doesn’t have the international code, instead you specify country as an atom with two-letters code

Same as parse/1, except it raises on error

Same as parse/2, except it raises on error

Functions

parse(number)

Specs

parse(pos_integer) :: {:ok, Map.t}
parse(String.t) :: {:ok, Map.t}

Parses a string or integer and returns a map with information about that number.

iex> Phone.parse("555112345678")
  {:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}}

  iex> Phone.parse("+55(51)1234-5678")
  {:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}}

  iex> Phone.parse("55 51 1234-5678")
  {:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}}

  iex> Phone.parse(555112345678)
  {:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}}
parse(number, atom)

Specs

parse(pos_integer, Atom.t) :: {:ok, Map.t}
parse(String.t, Atom.t) :: {:ok, Map.t}

Same as parse/1 but the number doesn’t have the international code, instead you specify country as an atom with two-letters code.

For NANP countries you can use the atom :nanp or two-letter codes for any country in NANP.

For United Kingdom is possible to use the more known acronym :uk or the official two-letter code :gb.

iex> Phone.parse("5112345678", :br)
{:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}}

iex> Phone.parse("(51)1234-5678", :br)
{:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}}

iex> Phone.parse("51 1234-5678", :br)
{:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}}

iex> Phone.parse(5112345678, :br)
{:ok, %{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}}
parse!(number)

Specs

parse!(pos_integer) :: Map.t
parse!(String.t) :: Map.t

Same as parse/1, except it raises on error.

iex> Phone.parse!("555112345678")
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}

iex> Phone.parse!("+55(51)1234-5678")
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}

iex> Phone.parse!("55 51 1234-5678")
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}

iex> Phone.parse!(555112345678)
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}
parse!(number, atom)

Specs

parse!(pos_integer, Atom.t) :: Map.t
parse!(String.t, Atom.t) :: Map.t

Same as parse/2, except it raises on error.

iex> Phone.parse!("5112345678", :br)
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}

iex> Phone.parse!("(51)1234-5678", :br)
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}

iex> Phone.parse!("51 1234-5678", :br)
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}

iex> Phone.parse!(5112345678, :br)
%{a2: "BR", a3: "BRA", country: "Brazil", international_code: "55", area_code: "51", number: "12345678"}