@fyne/yup-phone
Version:
Adds a phone number validation check to yup validator using google-libphonenumber.
74 lines (56 loc) • 2.73 kB
Markdown
[](https://travis-ci.org/abhisekp/yup-phone)
[](http://commitizen.github.io/cz-cli/)
[](https://github.com/semantic-release/semantic-release)
[](https://greenkeeper.io/)
<!-- ](https://app.fossa.com/reports/1f66512a-333d-428e-b620-fbac315d5a0e) -->
<!--
[](https://codecov.io/gh/abhisekp/yup-phone)
[](https://coveralls.io/github/abhisekp/yup-phone?branch=master)
-->
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 here [*libphonenumber*](https://github.com/googlei18n/libphonenumber/blob/master/README.md#readme).
```sh
$ yarn add yup-phone
```
```js
const Yup = require('yup');
require('yup-phone');
// validate any phone number (defaults to India for country)
const phoneSchema = Yup.string().phone().required();
phoneSchema.isValid('9876543210'); // → true
```
```js
const Yup = require('yup');
require('yup-phone');
// validate phone number loosely in the given region
const phoneSchema = Yup.string().phone('IN').required();
phoneSchema.isValid('+919876543210'); // → true
```
```js
const Yup = require('yup');
require('yup-phone');
// validate phone number strictly in the given region
const phoneSchema = Yup.string().phone('IN', true).required();
phoneSchema.isValid('+919876543210'); // → true
```
For more, check [yup-phone.test.ts](src/yup-phone.test.ts) file.
- Uses Rollup for bundling.
- Uses yarn for package management.
- Files are minified using closure compiler.
- Uses jest for testing.
- Generates CJS, UMD, and ESM builds.
- Use `yarn version --major|--minor|--patch` to version.
- Use tslint and prettier for code formatting.
- Uses semantic release for version.
- Use `yarn commit` to create a standard commit interactively.
```sh
$ yarn build
$ yarn test
```
[](LICENSE).