Valideasy

A super lightweight and flexible field validation utility for JavaScript/TypeScript. Perfect for validating request bodies, form submissions, or any object with required fields. Say goodbye to missing fields and hello to cleaner code! 🌟

📦 Installation

Get started by installing the valideasy package:

npm install valideasy
# Or
yarn add valideasy

🎁 Features

🔍 Simple Validation: Quickly check if required fields are present and non-empty.

⚡️ Lightweight: No dependencies, blazing-fast execution.

🔧 Flexible: Easily extendable and customizable for your specific needs.

🚀 Quick Start

It’s as easy as 1-2-3! Import the valideasy function and validate your data in no time.

import valideasy from 'valideasy';

const requestBody = {
    name: 'John Doe',
    email: '[email protected]',
    age: 30,
};

const requiredFields = ['name', 'email', 'password'];
const errorMessage = valideasy(requestBody, requiredFields);
if (errorMessage) {
    console.error(`🚫 ${errorMessage}`); // Output: "🚫 password is required!"
} else {
    console.log('✅ All fields are valid!');
}

📋 Express.js Request Body Validation Example

Use the valideasy function to validate incoming request data in an Express.js application. This example shows how to validate the req.body for required fields in an API endpoint.

import express from 'express';
import valideasy from 'valideasy';

const app = express();
app.use(express.json());

app.post('/register', (req, res) => {
    const requiredFields = ['name', 'email', 'password'];
    // Validate the request body
    const errorMessage = valideasy(req.body, requiredFields);
    if (errorMessage) {
        // If validation fails, send a 400 response with the error message
        return res.status(400).json({ error: errorMessage });
    }
    // If validation passes, proceed with the registration process
    res.status(200).json({ message: 'Registration successful!' });
})

How It Works

🧩 The valideasy function checks if the requiredFields exist in the requestBody.

⚠️ If a field is missing or an empty string, it returns an error message.

✅ If all fields are present and valid, it returns null.

📜 API Reference

valideasy(body, fields)

📝 Parameters

body (Object) - The object to validate (e.g., request body or form data).

fields (Array) - An array of strings specifying the required fields.

🔄 Returns

String - An error message indicating the first missing field.

null - If all required fields are present and valid.

💬 Contact

Have questions, feedback, or suggestions? Feel free to reach out at [email protected]