Cape validator

A validation library for Express used for validating request body.

Getting started

Inorder to install cape-validator in your project, just do

npm install cape-validator --save

after installation, you can just import the validator middleware into your project and use it in your routes. The validator middleware takes the validator schema as an argument.

node js

const { default: validator } = require("cape-validator");

node js with Typescript

We provide our types bundled with the package.

import validator from "cape-validator";

Using Validator Middleware

You can use the validator middleware as you use any other middleware.

router.post("/api/v1", validator(validationSchema), ...Other middlewares and handlers);

Write your own validation schema.

const validationSchema = [
    {
        type: ValidatorTypes.String,
        key: "name", //for nested keys you can directly pass the key example: 'a.b.c'
        validators: [FunctionTypes.required, FunctionTypes.notBlank, { min: 3 }, { max: 5 }], //...        other validation functions
        messages: {
            required: "Name is required",
            notBlank: "Name should not be empty",
            min: "Name should be minimum 3 chars",
            max: "Name should not be more thann 5 chars",
        } //... other validation function messages
    },
]  

DOCS

Enums

FunctionTypes : These are the supported validator functions.

declare enum FunctionTypes {
    required = "required",
    notBlank = "notBlank",
    min = "min",
    max = "max",
    checkType = "checkType,
    isEmail = "isEmail"
}

ValidatorTypes: These are supports types for validation. Currently, we support String, Number and Array validations.

declare enum ValidatorTypes {
    String = "String",
    Number = "Number",
    Array = "Array"
}

String Validators:

Required:

It checks whether the value is null.

Not blank:

It checks whether the value is not an empty string.

min:

It checks whether the value is atleast the mininum value.

max:

It checks whether the value is atmost the maximum value.

isEmail:

It checks whether the value is a valid email.

Number Validators:

Required:

It checks whether the value is null.

Not blank:

It checks whether the value is not zero.

min:

It checks whether the value is atleast the mininum value.

max:

It checks whether the value is atmost the maximum value.

Array Validators:

Required:

It checks whether the value is null.

Not blank:

It checks whether the value is not an empty Array.

min:

It checks whether the value is atleast the number of elements specified.

max:

It checks whether the value is atmost the number of elements specified.

checkType:

It checks whether the array contains only the elements of specified type.

Custom Error response.

You can also specify a custom error response and give a key to validator to populate the errors.

router.post("/add",  validator(dustbinValidationSchema, { customResponse: customResponse, key: "errors" }), ...other middlewares and handlers);

Support

For any issues or support, you can reach out to any of the below people, [email protected] [email protected] [email protected]

Authors and acknowledgment

Barath C - [email protected]

Saravanakumar S - [email protected]

Vignesh G - [email protected]

License

Licensed under ISC.