Cleanrjs

A minimal Javascript validation and masking library

✨ Features

• ✅ Simple and intuitive validation methods
• 🌍 Country-specific regex rules (e.g. India, UK, US, etc.)
• ⚙️ Supports custom regex overrides
• 🔁 Dynamic reinitialization via reinit()

📦 Installation

Using npm:

npm install cleanrjs

🧩 Basic Usage

The main validation entry point is Cleanr.validate, which provides simple boolean-based validation methods for different data types.

import Cleanr from 'cleanrjs';

Cleanr.validate.email('[email protected]');       // true
Cleanr.validate.email('invalid!email.com');      // false

Cleanr.validate.phone('+91-9876543210');         // true
Cleanr.validate.phone('12345');                  // false

Cleanr.validate.password('Str0ngPass!');         // true
Cleanr.validate.password('easypassword');        // false

Cleanr.validate.username('michael_scott');       // true

Cleanr.validate.postalCode('560001');            // true

Cleanr.validate.url('https://example.com');      // true

and more...

⚙️ Reinitialize with Custom Options

You can override default regex rules or switch countries at runtime using reinit().

Cleanr.reinit({
  country: 'ca', // Switch to Canada
  overrideRegex: {
    phone: /^[2-9]\d{9}$/, // Custom phone rule
  },
});

You can also add a new regex rule while reinit by adding a new key-value pair to the overrideRegex.

More yet to come.