@meanie/joi-country
v2.2.0
Published
A Joi extension to validate countries
Downloads
33
Maintainers
Readme
@meanie/joi-country
A Joi extension to validate countries
Features
- Extends string validation to include a country code validator
- Uses a supplied validator function to avoid relying on a fixed country codes list
- Simply load or create the validator you want, and pass it to the Joi extension
Installation
#npm
npm install @meanie/joi-country
#yarn
yarn add @meanie/joi-country
Usage
const Joi = require('@hapi/joi');
const JoiCountry = require('@meanie/joi-country');
//Validator
const countryCodeValidator = function(code) {
//...some validation against a list of country codes
};
//Set validator
JoiCountry.setValidator(countryCodeValidator);
module.exports = Joi.extend(JoiCountry);
Examples
const schema = Joi.object({
country: Joi.string().country(),
});
Issues & feature requests
Please report any bugs, issues, suggestions and feature requests in the meanie-joi-country issue tracker.
Contributing
Pull requests are welcome! If you would like to contribute to Meanie, please check out the Meanie contributing guidelines.
Sponsor
This package has been kindly sponsored by Hello Club, an all in one club and membership management solution complete with booking system, automated membership renewals, online payments and integrated access and light control. Check us out if you happen to belong to any kind of club or if you know someone who helps run a club!
License
(MIT License)
Copyright 2019-2020, Adam Reis