validate-indian-data
Version:
A simple utility to validate Indian phone numbers, PAN, Aadhar, PIN codes, and vehicle numbers.
167 lines (111 loc) • 3.4 kB
Markdown
# 📦 validate-indian-data
[](https://www.npmjs.com/package/validate-indian-data)
A tiny, zero-dependency utility to **validate Indian-specific inputs** like:
- 🇮🇳 Indian Mobile Numbers
- 🔢 Aadhar Numbers
- 🧾 PAN Card Numbers
- 📮 PIN Codes
- 🚗 Vehicle Registration Numbers
Use it in backend, frontend, or CLI tools — **super lightweight**, built for speed.
## ✨ Features
- ✅ **Zero Dependencies** – No bloat, just pure JavaScript.
- ✅ **Lightweight** – Minimal bundle size.
- ✅ **Reliable** – Uses regex for validation.
- ✅ **Easy to Use** – Clean, intuitive API.
- ✅ **Universal** – Works in Node.js & browser environments.
## 🚀 Installation
```bash
npm install validate-indian-data
```
or with Yarn:
```bash
yarn add validate-indian-data
```
## 📖 Usage
### CommonJS (Node.js)
```js
const {
isValidIndianPhone,
isValidAadhar,
isValidPAN,
isValidPIN,
isValidVehicleNumber
} = require('validate-indian-data');
```
### ES Modules
```js
import {
isValidIndianPhone,
isValidAadhar,
isValidPAN,
isValidPIN,
isValidVehicleNumber
} from 'validate-indian-data';
```
## ✅ API Reference
### `isValidIndianPhone(phone: string): boolean`
Checks for 10-digit Indian phone number starting with 6/7/8/9.
```js
console.log(isValidIndianPhone("9876543210")); // true
console.log(isValidIndianPhone("0123456789")); // false
```
### `isValidAadhar(aadhar: string): boolean`
Checks if string contains exactly 12 digits.
```js
console.log(isValidAadhar("123456789012")); // true
console.log(isValidAadhar("1234")); // false
```
### `isValidPAN(pan: string): boolean`
Validates Indian PAN number format like `ABCDE1234F`.
```js
console.log(isValidPAN("ABCDE1234F")); // true
console.log(isValidPAN("abcde1234f")); // false
```
### `isValidPIN(pincode: string): boolean`
Validates a 6-digit Indian PIN Code.
```js
console.log(isValidPIN("110001")); // true
console.log(isValidPIN("12345")); // false
```
### `isValidVehicleNumber(vehicle: string): boolean`
Validates Indian vehicle number like `MH12AB1234`, `DL10C1234`.
```js
console.log(isValidVehicleNumber("MH12AB1234")); // true
console.log(isValidVehicleNumber("DL10C1234")); // true
console.log(isValidVehicleNumber("ka01ab1234")); // false
```
## 🛠️ Development
### Setup
```bash
git clone https://github.com/ankitkmr150802/Publish_npm_package-validate-indian-data.git
cd Publish_npm_package-validate-indian-data
npm install
```
### Running Tests
```bash
npm test
```
> ✅ Tests are basic/manual right now. You can add `jest` or `mocha` for automated testing later.
## 🤝 Contributing
Contributions are welcome!
1. Fork the repo
2. Create your feature branch (`git checkout -b feature/my-feature`)
3. Commit your changes (`git commit -m 'add a new validator'`)
4. Push to the branch (`git push origin feature/my-feature`)
5. Open a Pull Request ✅
## 📞 Contact
If you have any feedback, suggestions, or just want to say hi:
**Ankit Kumar**
GitHub: [https://github.com/ankitkmr150802](https://github.com/ankitkmr150802)
Email: ankitkmr1508@gmail.com