Quickstart

Getting started with @nhtio/phone-object is quick and easy. Just follow the steps below and you'll be up and running in no time.

Installation

You can install @nhtio/phone-object directly from your preferred package manager

npm

npm i @nhtio/phone-object

pnpm

pnpm add @nhtio/phone-object

yarn

yarn add @nhtio/phone-object

Usage

Import the Phone Object

import { Phone } from '@nhtio/phone-object'

Create a new Phone Object

const phone = new Phone('202-456-141', 'US')
const phone = new Phone('202-456-1414', 'US')
const phone = new Phone('(202) 456-1414', 'US')
const phone = new Phone('+1 (202) 456-1414', 'US')
const phone = new Phone('202.456.1414', 'US')
const phone = new Phone('202/4561414', 'US')
const phone = new Phone('1 202 456 1414', 'US')
const phone = new Phone('+12024561414', 'US')
const phone = new Phone('1 202-456-1414' 'US')

Get the phone number in different formats

phone.raw // 2024561414
phone.national // (202) 456-1414
phone.international // +1 202-456-1414
phone.e164 // +12024561414

Get the country code

phone.country // US

Get a timezone suggestion

phone.timezone // America/New_York

Get the type of line

phone.valid // true
phone.type // FIXED_LINE_OR_MOBILE
phone.mobile // true

Serialize for storage

phone.serialize() // <base64 encoded string>

Deserialize from storage

const phone = Phone.deserialize(<base64 encoded string>)