📜 README for backend-response-helper

📌 About

backend-response-helper provides a standardized API response helper for Node.js applications.

🚀 Installation

Run the following command inside your backend project:

npx backend-response-helper

📌 What This Package Does

1️⃣ Creates src/utils/responseHelper.js
2️⃣ Provides standardized API response handling.

📝 responseHelper.js

const responseHelper = {
  success: (res, message = 'Success', data = {}) => {
    res.status(200).json({ status: 'success', message, data });
  },
  error: (res, message = 'Error', statusCode = 500, errors = {}) => {
    res.status(statusCode).json({ status: 'error', message, errors });
  },
  unauthorized: (res, message = 'Unauthorized') => {
    res.status(401).json({ status: 'error', message });
  },
  forbidden: (res, message = 'Forbidden') => {
    res.status(403).json({ status: 'error', message });
  },
  notFound: (res, message = 'Not Found') => {
    res.status(404).json({ status: 'error', message });
  },
};

module.exports = responseHelper;

📌 How to Use

const responseHelper = require('../utils/responseHelper');

const getUser = async (req, res) => {
  try {
    const user = { id: 1, name: 'John Doe' };
    responseHelper.success(res, 'User fetched successfully', user);
  } catch (error) {
    responseHelper.error(res, 'Something went wrong');
  }
};

module.exports = { getUser };

✅ Features

✔ Standardized API responses
✔ Reduces redundant code in controllers
✔ Handles common HTTP response statuses