Git Product home page Git Product logo

phone's Introduction

Phone

Build Status Phone version Inline docs Hex.pm GitHub issues GitHub license

Phone number parser for telephone numbers in international standard or missing international country code, for Elixir.

About

What is, what isnt and what will be about Phone:

  1. It isnt: * Intended to work as libphonenumber. * Prepared to format numbers. * Necessary any information about the number if in international standard.
  2. It is: * A real parser, created to extract information based only in the number. * Prepared to work with numbers not only in the international standard.
  3. It will have:
    • Area code info for every country that numbering plan has area codes.
  • Patterns:
    • Countries without area code info:

      %{
        country: "Country Name",
        a2: "Alpha-2",
        a3: "Alpha-3",
        international_code: "1",
        area_code: "yyy",
        number: "xxxxxxx"
      }
    • Countries with area code info:

      %{
        country: "Country Name",
        a2: "Alpha-2 code",
        a3: "Alpha-3 code",
        international_code: "1",
        number: "xxxxxxx",
        area_code: "yyy",
        area_name: "Area Name",
        area_type: "state",
        area_abbreviation: "AN"
      }

Area Codes

Countries that already has area code info:

  • United States.
  • Canada.

Vocabulary

  • a2: Alpha-2, two letters code for country names.
  • a3: Alpha-3, three letters code for country names.
  • NANP: North American Numbering Plan, numbering plan for countries with international code number 1.
  • Numbering Plan: The rules and specifications of how telephone numbers works in a given country.

Installation

Add to your depencies like any other hex package.

defp deps do
  [{:phone, "0.1.1"}]
end

##Contributing

##Changelog

##Code of Conduct

License

Phone is under Apache v2.0 license. Check the LICENSE file for more details.

phone's People

Contributors

fcevado avatar bsanyi avatar jedschneider avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.