2.0.0 • Published 4 years ago
phone-lk v2.0.0
phone-lk
With a given phone number, validate and reformat the mobile phone number to the 94XXXXXXXXX and reveal information about phone numbers such as device category(mobile/landline), Service provider information, and landline geolocation. The purpose of this is to allow us to identify mobile numbers and format number to 94XXXXXXXXX that requires most local SMS gateway providers in Sri Lanka. 🇱🇰
Install
npm install phone-lk
or
yarn add phone-lk
Basic usage
Array Format
const {phone} = require('phone-lk');
phone("0775489485"); // -> [ '94775489485', 'mobile', 'dialog', null ]
phone("912225492"); // -> [ '94912225492', 'landline', 'sri lanka telecom', 'galle' ]
phone("0792225492"); // -> return [] as it is not valid Sri Lanka phone number
Object Format
const {phone} = require('phone-lk');
phone("0775489485", true); // -> { isValid: true, formattedNumber: '94775489485', category: 'mobile', operator: 'dialog', area: null }
phone("912225492", true); // -> { isValid: true, formattedNumber: '94912225492', category: 'landline', operator: 'sri lanka telecom', area: 'galle' ]
phone("0792225492", true); // -> { isValid: false }
Returned Values
Category
- mobile
- landline
Landline Operators
- sri lanka telecom
- dialog
- lanka bell
- tritel
Mobile Operators
- mobitel
- dialog
- hutch
- airtel
Area Codes
- ampara
- anuradhapura
- avissawella
- bandarawela
- batticalo
- chilaw
- colombo
- galle
- gampaha
- hambantota
- hatton
- jaffna
- kalmunai
- kalutara
- kandy
- kegalle
- kurunagala
- mannar
- matale
- matara
- monaragala
- nawalapitiya
- negombo
- nuwara eliya
- panadura
- polonnaruwa
- ratnapura
- trincomalee
- vauniya
License
This project is licensed under the MIT license.