vb-response

A lightweight Express.js utility for standardized API responses.

Installation

npm install vb-response

Usage

const express = require("express");
const {
  success,
  created,
  error,
  notFound,
  unauthorized,
  validationError,
} = require("vb-response");

const app = express();

app.get("/", (req, res) => {
  success(res, {
    message: "API is running",
    data: {
      version: "1.0.0",
    },
  });
});

app.listen(3000);

Methods

success()

success(res, {
  message: "Data fetched successfully",
  data: users,
});

Response:

{
  "success": true,
  "message": "Data fetched successfully",
  "data": []
}

created()

created(res, {
  message: "User created successfully",
  data: user,
});

Status Code: 201

error()

error(res, "Internal Server Error");

Status Code: 500

notFound()

notFound(res, "User not found");

Status Code: 404

unauthorized()

unauthorized(res, "Invalid token");

Status Code: 401

validationError()

validationError(res, {
  email: "Email is required",
  password: "Password must be at least 8 characters",
});

Status Code: 422

License

MIT

Author

Vinayagam Balu