Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abhisekp/yup-phone
☎️ Adds a phone number validation check to yup validator using google-libphonenumber
https://github.com/abhisekp/yup-phone
codecov fossa-status google google-libphonenumber libphonenumber maintainer-wanted needs-maintainer number phone validation yup yup-phone yup-validator
Last synced: 2 days ago
JSON representation
☎️ Adds a phone number validation check to yup validator using google-libphonenumber
- Host: GitHub
- URL: https://github.com/abhisekp/yup-phone
- Owner: abhisekp
- License: mit
- Created: 2019-05-11T15:53:13.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-16T19:06:21.000Z (5 months ago)
- Last Synced: 2024-12-18T18:58:15.216Z (4 days ago)
- Topics: codecov, fossa-status, google, google-libphonenumber, libphonenumber, maintainer-wanted, needs-maintainer, number, phone, validation, yup, yup-phone, yup-validator
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/yup-phone
- Size: 4.78 MB
- Stars: 240
- Watchers: 6
- Forks: 26
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# yup-phone [](LICENSE) [](https://www.npmjs.com/package/yup-phone "yup-phone npm") [](https://twitter.com/intent/tweet?text=Are+you+still+validating+phone+numbers+using+regex%3F%0D%0AUse+%40npmjs+module+for+adding+phone+number+validation+%23yup+%23yupphone+%0D%0A%0D%0A%60npm+install+-S+yup+yup-phone%60+%E2%98%8E%EF%B8%8F%0D%0A%0D%0A&hashtags=javascript,Nodejs,validation,regex,npm,phone&via=abhisek&related=abhisek%3ADeveloper,npmjs&url=https://www.npmjs.com/package/yup-phone) 
[](https://travis-ci.org/abhisekp/yup-phone)
[](http://commitizen.github.io/cz-cli/)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fabhisekp%2Fyup-phone?ref=badge_shield)
[](https://snyk.io/test/github/abhisekp/yup-phone?targetFile=package.json)
[](https://app.codacy.com/manual/abhisekp/yup-phone?utm_source=github.com&utm_medium=referral&utm_content=abhisekp/yup-phone&utm_campaign=Badge_Grade_Settings)
> Adds a phone number validation check to yup validator using [**google-libphonenumber**](https://www.npmjs.com/package/google-libphonenumber) which gives accurate validation checks.
_Read more about the **core library** here_ [*libphonenumber*](https://github.com/googlei18n/libphonenumber/blob/master/README.md#readme).
_Read more about **yup** validator here_ [*yup*](https://www.npmjs.com/package/yup)
## Install
```sh
# npm install --save yup-phone
$ npm add yup-phone
```
## Test
Check validation in [Codesandbox](https://codesandbox.io/s/yup-phone-validation-u4p8n?file=/src/App.js)
## Examples
```js
// See https://repl.it/repls/WiryCleverPatches
import * as yup from 'yup';
// const yup = require("yup");
import "yup-phone";
// require("yup-phone");
// validate any phone number (defaults to India for country)
const phoneSchema = yup.string()
.phone()
.required();
(async () => {
console.log(await phoneSchema.isValid("9876543210")); // → true
})();
```
----
```js
// See https://repl.it/repls/SwiftImpossibleCertification
import * as yup from 'yup';
// const yup = require("yup");
import "yup-phone";
// require("yup-phone");
// validate phone number loosely in the given region
const phoneSchema = yup.string()
.phone("IN")
.required();
(async () => {
console.log(await phoneSchema.isValid('+919876543210')); // → true
})();
```
----
```js
// See https://repl.it/repls/PartialAlicebluePrediction
import * as yup from 'yup';
// const yup = require("yup");
import "yup-phone";
// require("yup-phone");
// validate phone number strictly in the given region
const phoneSchema = yup.string()
.phone("IN", true)
.required();
console.log(phoneSchema.isValidSync("+919876543210")); // → true
```
----
```js
// See https://repl.it/repls/UniqueForsakenDownloads
import * as yup from 'yup';
// const yup = require("yup");
import "yup-phone";
// require("yup-phone");
// validate phone number strictly in the given region with custom error message
const phoneSchema = yup.string()
.phone('IN', true, '${path} is invalid')
.required();
try {
phoneSchema.validateSync('+1 345 9490088');
} catch (error) {
console.log(error.message); // → this is invalid
}
```
----
For more examples, check [yup-phone.test.ts](src/yup-phone.test.ts) file.
### Module Sizes
```
Destination: dist/yup-phone.umd.js
Bundle Size: 544.08 KB
Minified Size: 537.41 KB
Gzipped Size: 107.04 KB
```
```
Destination: dist/yup-phone.umd.min.js
Bundle Size: 508.65 KB
Minified Size: 506.46 KB
Gzipped Size: 105.73 KB
```
```
Destination: dist/yup-phone.esm.js
Bundle Size: 648 B
Minified Size: 646 B
Gzipped Size: 370 B
```
```
Destination: dist/yup-phone.cjs.js
Bundle Size: 1.35 KB
Minified Size: 1.34 KB
Gzipped Size: 662 B
```
### Contributing
- Uses Rollup for bundling.
- Uses npm for package management.
- Files are minified using closure compiler.
- Uses jest for testing.
- Generates CJS, UMD, and ESM builds.
- Use `npm version [major|minor|patch]` to version.
- Use tslint and prettier for code formatting.
- Uses semantic release for version.
- Use `npx cz` to create a standard commit interactively.
```sh
$ npm run build # Build for production
$ npm test # Run tests
$ npm publish # Publish npm package (prompts for version)
```
## License
[MIT](LICENSE).
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fabhisekp%2Fyup-phone?ref=badge_large)