validate-aadhaar-ashish/README.md

Validate Indian Aadhaar numbers using Verhoeff algorithm

# @ashish/validate-aadhaar

✅ Validate Indian Aadhaar numbers using the Verhoeff checksum algorithm.

This lightweight NPM package helps you verify if an Aadhaar number is valid, based on the official Verhoeff checksum.

---


## 📦 Installation

```bash
npm install @ashish/validate-aadhaar
````

---


## 🔧 Usage

```js
// CommonJS
const isValidAadhaar = require('@ashish/validate-aadhaar');

// ES Module
// import isValidAadhaar from '@ashish/validate-aadhaar';

console.log(isValidAadhaar("123412341234")); // false
console.log(isValidAadhaar("868997338869")); // true (example)
```

---


## 📚 API

### `isValidAadhaar(aadhaarNumber: string): boolean`

* Returns `true` if valid Aadhaar number
* Returns `false` if invalid or malformed

---


## ⚙️ How It Works

This package implements the [Verhoeff algorithm](https://en.wikipedia.org/wiki/Verhoeff_algorithm), which is officially used for Aadhaar number validation in India.

---


## 📄 License

MIT © Ashish Kumar