1.0.3 • Published 3 months ago

http-status-utility v1.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
3 months ago

HTTP Status Utility

NPM

This lightweight JavaScript library provides utility functions to work with HTTP status codes. It includes functions to get the status message from a given status code and vice versa. The library is easy to use and can be integrated into your projects effortlessly.

Installation

To use this library, you can install it via npm:

$ npm install http-status-utility

Usage

const { StatusCode, getStatus, getCode } = require('http-status-utility');

// Get the status message from a status code
const statusMessage = getStatus(200);
console.log(statusMessage); // Output: "OK"

// Get the status code from a status message
const statusCode = getCode("Not Found");
console.log(statusCode); // Output: 404

Functions

  • getStatus(code)

Parameters:

code (Number): HTTP status code. Returns: (String) The corresponding status message.

  • getCode(status)

Parameters:

status (String): HTTP status message. Returns: (Number) The corresponding status code.

Examples

Example 1:

const { StatusCode, getStatus, getCode } = require('http-status-utility');

const statusMessage = getStatus(404);
console.log(statusMessage); // Output: "Not Found"

const statusCode = getCode("OK");
console.log(statusCode); // Output: 200

Example 2:

const { StatusCode, getStatus, getCode } = require('http-status-utility');

const statusMessage = getStatus(500);
console.log(statusMessage); // Output: "Internal Server Error"

const statusCode = getCode("Bad Request");
console.log(statusCode); // Output: 400

StatusCode

The StatusCode module provides a collection of HTTP status codes along with their associated descriptions. These codes are grouped into different categories, such as Client Errors, Informational, Redirection, Server Errors, and Success.

Usage

To use this module in your JavaScript/Node.js application, first, import it as follows:

const { StatusCode } = require('http-status-utility');

Example

const { StatusCode } = require('http-status-utility');

const status = StatusCode.SuccessOK;
console.log(status); // Output: 200

Feel free to customize this library according to your project requirements. Enjoy using it!

License

MIT

1.0.3

3 months ago

1.0.2

3 months ago

1.0.1

3 months ago

1.0.0

3 months ago