@dinush/srilankan-phone-number-validator

Sri Lankan Phone Number Validator

This package validates all Sri Lankan phone numbers including mobile and landline numbers.

Table of Contents

1. Installation
2. Usage
3. Contributing
4. Author
5. Credits
6. License

Installation

via npm

npm i @dinush/srilankan-phone-number-validator --save

or via yarn

yarn add @dinush/srilankan-phone-number-validator

Usage

The module accepts the various Number format +94xxxxxxxxx, 94xxxxxxxxx, 07XXXXXXXX, 7XXXXXXXX. However the module returns the phone number in the format 7XXXXXXXX

var { validateLKPhone } = require("@dinush/srilankan-phone-number-validator")

validateLKPhone("+94xxxxxxxxx") //returns JSON object
validateLKPhone("94xxxxxxxxx") //returns JSON object
validateLKPhone("07xxxxxxxx") //returns JSON object
validateLKPhone("7xxxxxxxx") //returns JSON object

valid phone number response

{
    "phone": "772100100",
    "valid": true,
    "info": "Is valid srilankan phone number",
    "type": "mobile"
}

Invalid phone number response

{
  "phone": "94688200567563",
  "valid": false,
  "info": "Phone number 94688200567563 is not a valid srilankan number",
  "type": "unknow"
}

More Options To simply determine if a number is valid or not

validateLKPhone("[phone]").valid ; // true 

To get simply determine if a number a land line or mobile

validateLKPhone("[phone]").type ; // mobile 

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Author

Author Dinush Chathurya

Credits

Inspired by Alex Ssanya
Regex Credit Ayesh Karunaratne

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright (c) 2022 Dinush Chathurya and codingtricks.io