reshttp v2.0.2

reshttp - HTTP Status Codes and Messages

reshttp is a comprehensive object that contains HTTP status codes and their professional messages. This can be used across your Node.js/Express application to standardize error handling and responses in a formal and consistent manner.

Table of Contents

• Overview
• Informational Responses (1xx)
• Success Responses (2xx)
• Redirection Responses (3xx)
• Client Error Responses (4xx)
• Server Error Responses (5xx)
• Usage Example

Overview

The reshttp object includes all major HTTP status codes, from 1xx (Informational) to 5xx (Server Errors), with associated professional messages. These messages are designed to provide clarity and helpful information to both users and developers.

Installation

NPM

npm install reshttp

PNPM

pnpm add reshttp

YARN

yarn add reshttp

BUN

bun add reshttp

Usage

import express from "express";
import reshttp from "reshttp";


console.log(reshttp.okMessage)
console.log(reshttp.okCode)

const app = express();

app.get("/example", (req, res) => {
  if (!req.query.id) {
    return res.status(reshttp.badRequestCode).json({status: reshttp.badRequestCode, message: reshttp.badRequestMessage});
  }
  res.status(reshttp.okCode).send(reshttp.okMessage);
});

app.listen(3000, () => {
  console.log("Server is running on port 3000");
});

In this example:

• If id is missing in the query, it returns a 400 Bad Request with a formal message.
• If id is provided, it returns a 200 OK response.

Informational Responses (1xx)

Success Responses (2xx)

Redirection Responses (3xx)

Client Error Responses (4xx)

Server Error Responses (5xx)

Usage Example

NOTE: it will work with any JAVASCRIPT framework

Here’s an example of how to use the reshttp object in an Express.js route:

Conclusion

The reshttp object helps you keep your status codes and messages organized in a consistent, professional format. You can easily expand or modify the messages as needed for your application.

Feel free to use this structure for error handling, success responses, and status codes throughout your project!

Let me know if you need further customization or have additional requests! 😊