A simple regex based exhaustive validator for PIN codes in India
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Nemo 108543a4b4 Updates regex 3 years ago
bin Initial commit for rubygem 3 years ago
src [ruby] Fix missing version 3 years ago
tests [ruby] Adds test and code 3 years ago
.editorconfig Python package and other updates 3 years ago
.gitattributes Fix .gitattributes 3 years ago
.gitignore Updates regex 3 years ago
.npmignore Improve all ignore files 3 years ago
.travis.yml [ci/ruby] Adds travis builds for Ruby 3 years ago
CODE_OF_CONDUCT.md [docs] Adds ruby in docs 3 years ago
Gemfile Don't commit Gemfile.lock 3 years ago
HACKING.md [docs] Adds ruby in docs 3 years ago
LICENSE Adds LICENSE and badges 3 years ago
Pipfile Python package and other updates 3 years ago
README.md Fix contributing 3 years ago
Rakefile [ruby] Adds test and code 3 years ago
composer.json Support phpunit 8.0 for php7.2 for now 3 years ago
package.json Version Bump (1.0.4) 3 years ago
phpunit.xml Initial commit 3 years ago
pincode-regex.js Adds support for browser-usage using browserify 3 years ago
pincode-validator.gemspec [docs] Adds ruby in docs 3 years ago
pyproject.toml Version Bump (1.0.4) 3 years ago
regex.txt Updates regex 3 years ago

README.md

india-pincode-regex Packagist Version Build Status npm GitHub package.json version GitHub

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).

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.

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.