Natural Polyglot Machine

    joi-phone-number
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/joi-phone-number package

    5.1.1 • Public • Published

    joi-phone-number

    Phone number validation rule for Joi

    Build Status Greenkeeper badge

    What

    Allows you to do Joi.string().phoneNumber().

    Uses https://github.com/ruimarinho/google-libphonenumber for validation.

    Which is a compiled version of the Google library https://github.com/googlei18n/libphonenumber.

    How

    const myCustomJoi = Joi.extend(require('joi-phone-number'));
    
    myCustomJoi.string().phoneNumber().validate('+32494567324');
    
    // The phone number can be transformed to a custom format
    // Note that this follows Joi's `convert` option
    myCustomJoi.string().phoneNumber({ defaultCountry: 'BE', format: 'e164' }).validate('494322456'); // '+32494322456'
    myCustomJoi.string().phoneNumber({ defaultCountry: 'BE', format: 'international' }).validate('494322456'); // '+32 494 32 24 56'
    myCustomJoi.string().phoneNumber({ defaultCountry: 'BE', format: 'national' }).validate('494322456'); // '0494 32 24 56'
    myCustomJoi.string().phoneNumber({ defaultCountry: 'BE', format: 'rfc3966' }).validate('494322456'); // 'tel:+32-494-32-24-56'
    myCustomJoi.string().phoneNumber({ defaultCountry: 'US', strict: true }).validate('7777777777'); // validation error
    myCustomJoi.string().phoneNumber({ defaultCountry: 'US'}).validate('7777777777'); // 7777777777

    Install

    npm i joi-phone-number

    DownloadsWeekly Downloads

    18,865

    Version

    5.1.1

    License

    MIT

    Unpacked Size

    13.6 kB

    Total Files

    5

    Last publish

    Collaborators

    • adrivanhoudt