@devmehq/phone-number-validator-js
Advanced tools
Comparing version 1.2.8 to 1.2.9
{ | ||
"name": "@devmehq/phone-number-validator-js", | ||
"version": "1.2.8", | ||
"description": "This library includes the geocoding, carrier mapping and timezone mapping functionalities that are available in some of googles libphonenumber libraries", | ||
"version": "1.2.9", | ||
"description": "Verify phone number, validate format, checking carrier name, geo and timezone infos.", | ||
"keywords": [ | ||
@@ -6,0 +6,0 @@ "telephone", |
@@ -8,13 +8,40 @@ # Phone Number information lookup, validation, carrier name, geo and timezone infos | ||
This library includes phone number lookup and validation, and the geocoding, carrier mapping and timezone mapping functionalities that are available in some of googles [libphonenumber](https://github.com/google/libphonenumber) libraries. | ||
### Verify phone number, validate format, checking carrier name, geo and timezone infos. | ||
To reduce the amount of data that needs to be loaded to geocode / carrier map a phone-number for each mapping only the relevant number prefixes are loaded from a binary json file (BSON). | ||
When the prefix could not be found in the provided locale the library tries to fall back to `en` as locale. | ||
> This library includes phone number lookup and validation, and the geocoding, carrier mapping and timezone mapping functionalities that are available in some of googles [libphonenumber](https://github.com/google/libphonenumber) libraries. | ||
> | ||
> To reduce the amount of data that needs to be loaded to geocode / carrier map a phone-number for each mapping only the relevant number prefixes are loaded from a binary json file (BSON). | ||
When the prefix could not be found in the provided locale the library tries to fall back to `en` as locale. | ||
> | ||
> The library supports Node.js only at the moment. | ||
The library supports Node.js only at the moment. | ||
## Features | ||
✅ Check phone number validity | ||
✅ Check phone number format | ||
✅ Check phone number carrier name | ||
✅ Check phone number geo location (city) | ||
✅ Check phone number timezone | ||
✅ Check phone number country code | ||
## Use cases | ||
- Increase delivery rate of SMS campaigns by removing invalid phone numbers | ||
- Increase SMS open rate and your marketing IPs reputation | ||
- Protect your website from spam, bots and fake phone numbers | ||
- Protect your product signup form from fake phone numbers | ||
- Protect your website forms from fake phone numbers | ||
- Protect your self from fraud orders and accounts using fake phone numbers | ||
- Integrate phone number verification into your website forms | ||
- Integrate phone number verification into your backoffice administration and order processing | ||
- Integrate phone number verification into your mobile apps | ||
## API / Cloud Hosted Service | ||
We offer this `phone verification and validation and more advanced features` in our Scalable Cloud API Service Offering - You could try it here [Phone Number Verification](https://dev.me/products/phone) | ||
## Self-hosting - installation and usage instructions | ||
@@ -38,5 +65,5 @@ | ||
- `geocoder(phonenumber: PhoneNumber, locale?: GeocoderLocale = 'en'): Promise<string | null>` - Resolved to the geocode or null if no geocode could be found (e.g. for mobile numbers) | ||
- `carrier(phonenumber: PhoneNumber, locale?: CarrierLocale = 'en'): Promise<string | null>` - Resolves to the carrier or null if non could be found (e.g. for fixed line numbers) | ||
- `timezones(phonenumber: PhoneNumber): Promise<Array<string> | null>` - Resolved to an array of timezones or null if non where found. | ||
- `geocoder(phonenumber: PhoneNumber, locale?: GeocoderLocale = 'en'): string | null` - Resolved to the geocode or null if no geocode could be found (e.g. for mobile numbers) | ||
- `carrier(phonenumber: PhoneNumber, locale?: CarrierLocale = 'en'): string | null` - Resolves to the carrier or null if non could be found (e.g. for fixed line numbers) | ||
- `timezones(phonenumber: PhoneNumber): Array<string> | null` - Resolved to an array of timezones or null if non where found. | ||
@@ -60,1 +87,12 @@ ## Examples | ||
``` | ||
## Testing | ||
```bash | ||
yarn test | ||
``` | ||
## Contributing | ||
Please feel free to open an issue or create a pull request and fix bugs or add features, All contributions are welcome. Thank you! | ||
## LICENSE [MIT](LICENSE.md) |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
13068056
96