2.0.0 • Published 3 years ago

joi-postalcode v2.0.0

Weekly downloads
352
License
GPL-3.0-or-later
Repository
github
Last release
3 years ago

joi-postalcode

Joi extension for validating postal codes worldwide using postal-codes-js.

Versions

  • Version 1.X is for Joi < v14
  • Version 2.X (latest) is for Joi > v14

How to Use

Get the required packages:

npm install joi joi-postalcode

Create an extended instance of Joi, then specify the 2-letter ISO country code as a parameter to postalCode in your schema:

const Joi = require('joi')
const joiPostalCode = Joi.extend(require('joi-postalcode'))
joiPostalCode.string().postalCode('CA').validate('A1A 1A1') // Canada
joiPostalCode.string().postalCode('').validate('90210') // Default country is US
joiPostalCode.string().postalCode('TR').validate('33150') // Turkey

See List of postal codes for a list of postal code formats and supported countries.