zod-phone-number

Zod Phone Number

Zod Phone Number is validation schema for Zod.

Installation

$ npm i zod-phone-number

Usage

const { data } = ZodPhoneNumber.phoneNumber({
  returningFormat: RETURNING_FORMAT.NATIONAL,
}).safeParse('[phone]'); // 010 60594488


const { data } = ZodPhoneNumber.phoneNumber({
  returningFormat: RETURNING_FORMAT.INTERNATIONAL,
}).safeParse('[phone]'); // [phone]

const { data } = ZodPhoneNumber.phoneNumber({
  returningFormat: RETURNING_FORMAT.ORIGINAL,
}).safeParse('[phone]'); // [phone]

const { data } = ZodPhoneNumber.phoneNumber({
  returningFormat: RETURNING_FORMAT.FORMATTED_VALUE,
}).safeParse('[phone]'); // [phone]

const { data } = ZodPhoneNumber.phoneNumber({
  returningFormat: RETURNING_FORMAT.RFC3966,
}).safeParse('[phone]'); // tel:[phone]

const { data } = ZodPhoneNumber.phoneNumber({
  returningFormat: RETURNING_FORMAT['E.164'],
}).safeParse('[phone]'); // [phone]


const { data } = ZodPhoneNumber.phoneNumber({
  returningFormat: RETURNING_FORMAT.VALUE__WITH_EXTRA_INFO,
}).safeParse('[phone]');
/*
output: {
        countryCode: 'EG',
        formattedNumber: '[phone]',
        nationalNumber: '1060594488',
        originalValue: '[phone]',
        countryCallingCode: '20',
      }
*/

Tests

To run the test suite, first install the dependencies then run npm test:

$ npm install
$ npm test

Support

Feel free to open issues on github.