req-valida

A strict express request validator middleware, used for ensuring the payload meets the requirement of an endpoint.

Whether amount is required in request.body or customerID in request.params, req-valida can handle everything. As a strict validator, req-valida throws error for any field present in request that is not expected for an endpoint.

valida is a Romanian verb, which means validate in English language.

Installation

npm install req-valida

or

yarn add req-valida

Usage

For cjs,

const { validate } = require("req-valida");

For esm,

import { validate } from "req-valida";

validate method takes an object of which looks like,

{
  location: "body",
  data: {
    amount: {
        rules: ["number", regex.number],
    },
    customerID: {
        rules: ["string"],
        isOptional: true,
    },
  },
}

Options

location can be body | query | params. The validate method will use location to look for required data on each invocation.

data object should be defined as how the payload is expected for that endpoint. However, each key in data object must have rules array. First element on rules array is the expected type of the key (in string format). Such as, in above example, amount is required in the body of some endpoint, and amount must be a number.

Second element on the rules array is optional RegEx validation. If provided, validate will test the value of the amount against the RegEx string.

After that, there's another optional property isOptional which can be sent with the each fields. Such as, in above example, customerID is optional in that request, so isOptional is sent true.

There can be case where every field in request is optional, in that case, instead of sending isOptional with the fields, validate allows another property outside of data called isOptional (similar to the fields) for these situation. It will tell validate to consider the whole data object to be optional.

An example router file with validate

const paymentRouter = require("express").Router();
const { validate } = require("req-valida");
const Payment = require("../controllers/payment");
const regex = require("../helpers/regex");

paymentRouter.post(
    "/intent",

    validate({
        location: "body",
        data: {
            amount: {
                rules: ["number", regex.number],
            },
            customerID: {
                rules: ["string"],
                isOptional: true,
            },
        },
    }),

    (request, response, next) => Payment.Intent.create(request, response, next)
);

module.exports = { paymentRouter };