Http-status-lite NPM

http-status-lite

The http-status-lite is a lightweight and comprehensive utility providing standardized HTTP status codes for applications. It simplifies the handling of HTTP response codes by offering predefined constants, ensuring clarity and consistency in API responses.

Key Features

Predefined HTTP Status Codes: Provides a comprehensive set of HTTP status codes for easy reference.
TypeScript Support: Includes strong type definitions for enhanced code safety and developer experience.
Immutable Constants: Ensures status codes cannot be modified, preventing unintended changes.
Lightweight & Efficient: Minimal footprint with high performance.
Easy Integration: Seamlessly integrates with any Node.js or TypeScript-based project.

Installation

To install the package, run the following command:

npm install http-status-lite

Usage

CommonJS

const httpStatusLite = require('http-status-lite');

console.log(httpStatusLite.OK); // Outputs: 200

Module (ESM)

import httpStatusLite from 'http-status-lite';

console.log(httpStatusLite.OK); // Outputs: 200

// TypeScript example:
import httpStatusLite, { HttpStatusType } from 'http-status-lite';

const successStatus: HttpStatusType = 'OK';
console.log(httpStatusLite[successStatus]); // Outputs: 200

Example Usage in an Express.js Application (ESM)

import httpStatusLite from 'http-status-lite';
const express = require('express');
const app = express();

app.get('/status', (req, res) => {
    res.status(httpStatusLite.OK).json({ message: 'Server is running!' });
});

app.listen(3000, () => console.log('Server running on port 3000'));

HTTP Status Code Categories

Informational Responses (100–199)

CONTINUE: 100
SWITCHING_PROTOCOLS: 101
PROCESSING: 102
EARLY_HINTS: 103

Successful Responses (200–299)

OK: 200
CREATED: 201
ACCEPTED: 202
NO_CONTENT: 204
PARTIAL_CONTENT: 206

Redirection Messages (300–399)

MULTIPLE_CHOICES: 300
MOVED_PERMANENTLY: 301
FOUND: 302
SEE_OTHER: 303
TEMPORARY_REDIRECT: 307
PERMANENT_REDIRECT: 308

Client Error Responses (400–499)

BAD_REQUEST: 400
UNAUTHORIZED: 401
FORBIDDEN: 403
NOT_FOUND: 404
METHOD_NOT_ALLOWED: 405
TOO_MANY_REQUESTS: 429
UNAVAILABLE_FOR_LEGAL_REASONS: 451

Server Error Responses (500–599)

INTERNAL_SERVER_ERROR: 500
NOT_IMPLEMENTED: 501
BAD_GATEWAY: 502
SERVICE_UNAVAILABLE: 503
GATEWAY_TIMEOUT: 504

License

This project is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International (CC BY-NC-ND 4.0).

You are free to:

Share — Copy and redistribute the material in any medium or format.

Under the following terms:

Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made.
NonCommercial — You may not use the material for commercial purposes.
NoDerivatives — If you remix, transform, or build upon the material, you may not distribute the modified material.

For more details, please visit the Creative Commons License Page.

Acknowledgments

Special thanks to the following resources:

MDN Web Docs - Comprehensive HTTP status code references.
Node.js Express Documentation - Guidance on handling HTTP responses.
TypeScript Docs - Best practices for defining and using type-safe constants.

FAQs

1. How do I determine the correct HTTP status code for my response?

HTTP status codes are categorized based on their meaning. Informational (100s), Success (200s), Redirection (300s), Client Errors (400s), and Server Errors (500s). Choose the appropriate category based on your response type.