Gathering detailed insights and metrics for rest-api-response-npm-jkg
Installations
npm install rest-api-response-npm-jkgDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
18.16.0
NPM Version
9.5.1
Score
47.7
Supply Chain
88.3
Quality
75.6
Maintenance
100
Vulnerability
99.6
License
Releases
Unable to fetch releases
Contributors
1
Download Statistics
Total Downloads
1,518
Last Day
1
Last Week
5
Last Month
28
Last Year
219
Bundle Size
214.26 kB
Minified
66.37 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
1.1.13
Package Id
rest-api-response-npm-jkg@1.1.13
Unpacked Size
10.79 kB
Size
3.22 kB
File Count
3
NPM Version
9.5.1
Node Version
18.16.0
Publised On
02 May 2023
Total Downloads
Cumulative downloads
Total Downloads
1,518
Last day
-50%
1
Compared to previous day
Last week
-73.7%
5
Compared to previous week
Last month
1,300%
28
Compared to previous month
Last year
-83.1%
219
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Versions
Installation
npm install rest-api-response-npm-jkg
Live DEMO:
- Node JS - Stackblitz DEMO
Parameters
The successResponse, errorResponse, customResponse, checkValidation, validationResponse, catchError functions are JavaScript functions that are used to send HTTP responses from a server to a client. They take in the following parameters:
-
res- Parameter that represents the HTTP response object that will be sent back to the client. -
err- Parameter that represents the error object that will be sent back to the client. -
data- Parameter that represents the data that will be sent back to the client. This can be any JSON object or value. -
message- Parameter that represents the message that will be sent back to the client along with the data. -
statusCode- Parameter that represents the HTTP status code that will be sent back to the client.
Functions
-
successResponse: This function takes in four parameters,res(required),data(required),message(optional), andstatusCode(optional). -
errorResponse: This function takes in four parameters,res(required),data(optional),message(optional), andstatusCode(optional). -
customResponse: This function takes in four parameters,res(required),data(optional),message(optional), andstatusCode(optional). -
validationResponse: This function takes in four parameters,res(required),data(required),message(optional), andstatusCode(optional). -
checkValidation: This function takes in four parameters,res(required) andreq(required). -
catchError: This function takes in four parameters,res(required) anderr(required).
Usage
To use these functions in a Node.js application, simply import the module and call the desired function with the appropriate parameters. For example.
app.js
const express = require('express');
// const { ... } = require('rest-api-response-npm-jkg');
const { body } = require("express-validator");
const app = express();
// Use functions as per requiremet
// ...
app.listen(3000, () => {
console.log('Server started on port 3000');
});
successResponse() sample code:
const { successResponse } = require('rest-api-response-npm-jkg');
app.get('/', (req, res) => {
const data = {
id: 12,
user_name: 'Jaykumar Gohil'
};
successResponse(res, data, 'Success message', 200);
});
errorResponse() sample code:
const { errorResponse } = require('rest-api-response-npm-jkg');
app.get('/error', (req, res) => {
let checkUser; // object
let message; // object
if(checkUser) {
message = "User not exist!"
}
errorResponse(res, checkUser, message, 400);
// or
errorResponse(res, null, message, 400);
// or
errorResponse(res, null, message);
// or
errorResponse(res, null, 'Error message');
});
customResponse() sample code:
const { customResponse } = require('rest-api-response-npm-jkg');
app.get('/custom', (req, res) => {
// Example 1
const data = [
{
access_token: "asdasds.asdsadsasq2we23easa.asdasdasdas",
name: 'namessss'
}
];
customResponse(res, data, 'Login Successfully', 200);
// or
customResponse(res, data);
// Example 2
customResponse(res, null, 'Token Expiration', 401);
});
checkValidation() sample code:
const { checkValidation } = require('rest-api-response-npm-jkg');
const { body } = require("express-validator");
const validationRequest = [
// validation for
// ...
body("password")
.notEmpty()
.withMessage("Password is requierd")
.isLength({ min: 6, max: 250 })
.withMessage("Minimum 6 character password require")
.trim(),
// ...
]
app.post('/api/user', validationRequest, (req, res) => {
// Validate the request parameters
checkValidation(res, req);
// If there are no validation errors, proceed with the request handling
// ...
});
validationResponse() sample code:
const { validationResponse } = require('rest-api-response-npm-jkg');
app.post('/api/login', (req, res) => {
// ...
// Create validation formated data for invalid password API response
data = {
password: [
"Invalid password",
]
}
validationResponse(res, data);
// or
validationResponse(res, data, "Validation failed!");
// or
validationResponse(res, data, "Validation failed!", 422);
});
catchError() sample code:
app.js
const { catchError } = require('rest-api-response-npm-jkg');
// ...
// default error messgae
app.use((error, req, res, next) => {
// All types of errors in a project will be handled by this tool, and an error response will be provided in the proper format
catchError(res, error);
});
// Use functions as per requiremet
// ...
app.listen(3000, () => {
console.log('Server started on port 3000');
});
demo:
app.get('/api/user', (req, res) => {
try {
// Handle the request and throw an error if needed
// ...
} catch (err) {
// Use the next method to handle the error, and the catchError function will handle the response.
next(err);
}
});
Why Use Response Helper Functions?
-
REST APIs have become an integral part of modern web development, and this code offers a standardized and reliable approach to generate HTTP responses in a Node.js application. These functions,
successResponse,errorResponse, andcustomResponse,checkValidation,validationResponse,catchErrorcan be used as helpers to handle different types of responses in a consistent format. -
By using these functions, you can prevent API format issues and save valuable development time. For frontend or mobile developers, these functions can be especially helpful since they provide a clear and predictable response structure that can be easily integrated into their application.
-
In addition to their practical benefits, using these functions is super easy to implement and use in your Node.js project. With just a few lines of code, you can experience the benefits of standardized and reliable HTTP responses.
-
By implementing these functions in your Node.js project, you can improve the overall user experience by providing clear and concise error messages and feedback. Give them a try and experience the benefits of standardized and reliable HTTP responses in your Node.js REST API development!
Conclusion
Above functions used for handling responses and errors in a server. successResponse is used to return a response with data, message, and status code, while errorResponse and customResponse handle errors and return responses accordingly. validationResponse reformats request parameters and returns an appropriate response, checkValidation validates request parameters and returns an appropriate response, and catchError is used to handle errors that occur during request processing and return a response with an error message.
No vulnerabilities found.
No security vulnerabilities found.