https://github.com/ex-phone-number/ex_phone_number

Elixir port of libphonenumber
https://github.com/ex-phone-number/ex_phone_number

Last synced: 3 months ago
JSON representation

Elixir port of libphonenumber

• Host: GitHub
• URL: https://github.com/ex-phone-number/ex_phone_number
• Owner: ex-phone-number
• License: mit
• Created: 2016-03-09T09:37:25.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-09-16T08:25:07.000Z (4 months ago)
• Last Synced: 2024-10-29T20:37:33.676Z (3 months ago)
• Language: Elixir
• Size: 1.03 MB
• Stars: 253
• Watchers: 23
• Forks: 61
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Format, normalize, and validate phone numbers. (Miscellaneous)

README

        
# ExPhoneNumber

[![CI](https://github.com/ex-phone-number/ex_phone_number/actions/workflows/build.yml/badge.svg)](https://github.com/ex-phone-number/ex_phone_number/actions/workflows/build.yml)

[![Module Version](https://img.shields.io/hexpm/v/ex_phone_number.svg)](https://hex.pm/packages/ex_phone_number)

[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/ex_phone_number/)

[![Total Downloads](https://img.shields.io/hexpm/dt/ex_phone_number.svg)](https://hex.pm/packages/ex_phone_number)

[![License](https://img.shields.io/hexpm/l/ex_phone_number.svg)](https://github.com/ex-phone-number/ex_phone_number/blob/master/LICENSE.md)

[![Last Updated](https://img.shields.io/github/last-commit/ex-phone-number/ex_phone_number.svg)](https://github.com/ex-phone-number/ex_phone_number/commits/master)

Elixir library for parsing, formatting, and validating international phone numbers.

Based on Google's [libphonenumber](https://github.com/googlei18n/libphonenumber).

**Current metadata version: v8.13.45.**

## Installation

Add `:ex_phone_number` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:ex_phone_number, "~> 0.4.5"}

  ]

end

```

## Usage

```elixir

iex> {:ok, phone_number} = ExPhoneNumber.parse("044 668 18 00", "CH")

{:ok,

 %ExPhoneNumber.Model.PhoneNumber{

   country_code: 41,

   country_code_source: nil,

   extension: nil,

   italian_leading_zero: nil,

   national_number: 446681800,

   number_of_leading_zeros: nil,

   preferred_domestic_carrier_code: nil,

   raw_input: nil

}}

iex> ExPhoneNumber.is_possible_number?(phone_number)

true

iex> ExPhoneNumber.is_valid_number?(phone_number)

true

iex> ExPhoneNumber.get_number_type(phone_number)

:fixed_line

iex> ExPhoneNumber.format(phone_number, :national)

"044 668 18 00"

iex> ExPhoneNumber.format(phone_number, :international)

"+41 44 668 18 00"

iex> ExPhoneNumber.format(phone_number, :e164)

"+41446681800"

iex> ExPhoneNumber.format(phone_number, :rfc3966)

"tel:+41-44-668-18-00"

```

## E164 Formatted Numbers

In E164 formatted numbers the country code can be detected. So you can pass them in to `ExPhoneNumber.parse/2` with `""` or `nil` as the second argument.

```elixir

iex> ExPhoneNumber.parse("+977123456789", "")

{:ok,

 %ExPhoneNumber.Model.PhoneNumber{

   country_code: 977,

   country_code_source: nil,

   extension: nil,

   italian_leading_zero: nil,

   national_number: 123456789,

   number_of_leading_zeros: nil,

   preferred_domestic_carrier_code: nil,

   raw_input: nil

 }}

```

## Development

There is a `mix update_metadata` task that downloads the latest `libphonenumber` metadata.

## Copyright and License

Copyright (c) 2023-2024 ExPhoneNumber

Copyright (c) 2016-2022 NLCollect B.V.

The source code is licensed under [The MIT License (MIT)](LICENSE.md)