india-pincode-regex/README.md

india-pincode-regex

Validate a Postal Index Number for India with a few regexes. The regexes are available in regex.txt. There is one regex per area code (the first digit of the PIN, which goes from 1-8).

Source

The source for the data is the "All India Pincode Directory" dataset on data.gov.in.

Usage

The regex.txt file is 32KB in size, so you can easily use it wherever you want, including browsers.

PHP

The package is available on packagist.

To use the PHP package:

use PIN\Validator as P;
P::validate('110011'); // returns true;

Node.js

The package is available on npm.

To use the package:

const P = require('pincode-validator');
P.validate('110011'); // returns true

Ruby

Add this line to your application's Gemfile:

gem 'pincode_validator'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pincode_validator

Browser

To use it in the browser, download the pincode-regex.js file and include it in your browser. Pincode is available as a Global variable.

<script src="../pincode-regex.js"></script>
<script>
Pincode.validate("560029"); // returns true
</script>

Since there is no hotline/CDN for this yet, please watch to repo to get notified of new releases.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/captn3m0/outliner.

Code of Conduct

Everyone interacting in the this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Contributing

• See HACKING.md for some development details.
• Pull requests are welcome for adding libraries in other languages (in the same repo).
• This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

Licensed under the MIT License. See LICENSE file for details.