password-chacker-xqwe/README.md

A simple password strength checker with basic and advanced validation

# Password Strength Checker

A simple password strength checking package for Node.js.

It provides two main functions:

- **`password_low(password)`** — Basic password validation (default export)  
- **`password_low_more_data(password)`** — Advanced password validation (named export)

---


## Installation

```bash
npm i password-chacker-xqwe
```

> Replace `password-chacker-xqwe` with the actual package name you published.

---


## Usage

Import the functions like this:

```js
import password_low, { password_low_more_data } from "your-package-name";

// Basic check (default export)
const basicValid = password_low("yourPassword");

// Advanced check (named export)
const advancedValid = password_low_more_data("yourPassword");

console.log("Basic validation:", basicValid);
console.log("Advanced validation:", advancedValid);
```

---


## What the functions return

## Basic Validation Output (`password_low`)

The `password_low` function returns an object like this:

```js
{
  status: 'success',
  is_valid: false,           // Boolean indicating if password passed validation
  password: '123',           // The input password
  score: 1,                  // Numeric score representing strength
  messages: [                // Array of messages explaining validation failures
    'Password must be 8 characters long',
    'Add at least one lowercase letters',
    'Add at least one uppercase letters',
    'Add at least one specials characters'
  ]
}
```

## Advanced Validation Output (`password_low_more_data`)

The `password_low_more_data` function returns a detailed object like this:

```js
{
  status: 'success',
  is_valid: false,               // Boolean indicating if password passed all advanced checks
  password: 'Subham04',          // The input password
  score: 3.5,                   // Numeric score representing password strength
  validation_details: {          // Detailed validation info
    length: {
      is_valid: true,            // Length check passed or not
      min_length: 8,
      max_length: 128,
      current_length: 8,
      message: 'for your password must be 12 '
    },
    character_types: {           // Details about character types in the password
      score: 3,
      is_valid: false,
      uppercase: {/* details */},
      lowercase: {/* details */},
      digits: {/* details */},
      special_characters: {/* details */}
    }
  },
  whitespace: {                  // Whitespace check result
    is_valid: true,
    message: 'No whitespace detected'
  }
}
```
---


## Example

```js
import password_low, { password_low_more_data } from "password-chacker-xqwe";

console.log(password_low("123"));          // false (too short or invalid)
console.log(password_low_more_data("Subham04")); // true or false based on advanced rules
```

---


## License

MIT License © Dibyajyoti Parida