Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dinushchathurya/srilankan-phone-number-validator
Sri Lankan Phone Number Validator NPM Package
https://github.com/dinushchathurya/srilankan-phone-number-validator
dinush dinush-chathurya dinushchathurya npm npm-package npmjs npmjs-packages open-source open-source-srilanka opensource srilankan-mobile-number-validator srilankan-mobile-validator
Last synced: 18 days ago
JSON representation
Sri Lankan Phone Number Validator NPM Package
- Host: GitHub
- URL: https://github.com/dinushchathurya/srilankan-phone-number-validator
- Owner: dinushchathurya
- License: mit
- Created: 2022-05-15T06:32:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-05-15T11:29:57.000Z (over 2 years ago)
- Last Synced: 2024-12-14T20:45:45.392Z (19 days ago)
- Topics: dinush, dinush-chathurya, dinushchathurya, npm, npm-package, npmjs, npmjs-packages, open-source, open-source-srilanka, opensource, srilankan-mobile-number-validator, srilankan-mobile-validator
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@dinush/srilankan-phone-number-validator
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Sri Lankan Phone Number Validator
This package validates all Sri Lankan phone numbers including mobile and landline numbers.
## Table of Contents
## 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("+94717187425").valid ; // true
```
To get simply determine if a number a land line or mobile
```
validateLKPhone("+94717187425").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](https://dinushchathurya.github.io/)
## Credits
Inspired by [Alex Ssanya](https://github.com/alexxsanya)
Regex Credit [Ayesh Karunaratne](https://github.com/Ayesh)
## 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