api-response-wrapper
v1.0.1
Published
A lightweight, flexible API response handler for Express and services.
Maintainers
Readme
api-response-wrapper
A lightweight and flexible Node.js utility for standardizing API responses — works seamlessly with Express and in service layers.
🚀 Features
- ✅ Clean, consistent API responses
- ✅ Works with or without Express
resobject - ✅ No dependencies
- ✅ Developer-friendly API
- ✅ Supports future extensibility (logging, i18n, etc.)
📦 Installation
npm install api-response-wrapper🔧 Usage
✅ In Express
const resHandler = require('api-response-wrapper');
app.get('/api/user', (req, res) => {
const user = { id: 1, name: 'Trithanka' };
return resHandler.success(res, 'User fetched successfully', user);
});✅ In Service/Logic Layer
const resHandler = require('api-response-wrapper');
function getUserData() {
const user = { id: 1, name: 'Trithanka' };
return resHandler.success('User fetched successfully', user);
}🧾 Response Format
{
"success": true,
"message": "User fetched successfully",
"data": {
"id": 1,
"name": "Trithanka"
},
"statusCode": 200
}📘 API Methods
| Method | Description |
|--------------------|------------------------------------------|
| success(...) | Send or return a 200 success response |
| error(...) | Return a 400 bad request |
| unauthorized(...)| Return a 401 unauthorized |
| forbidden(...) | Return a 403 forbidden |
| serverError(...) | Return a 500 internal server error |
| schema() | Get response object schema definition |
✨ Example
// With res
resHandler.error(res, 'Invalid ID');
// Without res
const response = resHandler.error('Invalid ID');
console.log(response);
/*
{
success: false,
message: 'Invalid ID',
data: null,
statusCode: 400
}
*/📄 License
MIT © Trithanka
