captn3m0/pincode

A simple regex based validator for PIN codes in India

1.0.4 2020-04-21 15:41 UTC

This package is auto-updated.

Last update: 2021-11-11 16:12:13 UTC


README

Validate a Postal Index Number for India with a few regexes and zero false-positives. 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). Available as a package for Ruby, Python, Node.js, and browsers.

Why?

A simple \d{6} approach marks a lot of invalid pincodes as valid. Out of the 900000 possible combinations, only approximately 155600 are valid pincodes in India. A simple example is 111111 which is an invalid pincode, but any simple 6 digit-check will pass it as a valid one. File a PR to support any other language.

Source

The source for the data is the "All India Pincode Directory" dataset on data.gov.in. The last updated date for the dataset is currently 30th May 2019.

Usage

The regex.txt file is 32KB in size, so you can easily use it wherever you want, including browsers. If you are using any of the packages below, this is already delivered compressed.

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.

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.