npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

http-response-utils

v0.1.6

Published

HTTP response codes and custom error messages.

Downloads

18

Readme

HTTP Status Codes and Custom Errors

This NPM package provides HTTP status code constants and custom error classes for easy use in your Node.js applications. It simplifies the process of handling HTTP errors by allowing you to import predefined status codes and error classes.

Installation

Install the package via npm:

npm install http-status-errors

Usage

Importing HTTP Status Codes

You can import the HTTP status codes from the package:

import { status } from 'http-status-errors';

console.log(status.HTTP_BAD_REQUEST); // 400
console.log(status.HTTP_NOT_FOUND); // 404

Importing Custom Error Classes

The package provides custom error classes for common HTTP errors:

import {
  BadRequestError,
  InternalServerError,
  InvalidRequestError,
  NotFoundRequestError,
  UnauthorizedRequestError,
  ForbiddenRequestError,
} from 'http-status-errors';

// Example usage
try {
  throw new BadRequestError('This is a bad request');
} catch (error) {
  console.error(error.statusCode); // 400
  console.error(error.message); // 'This is a bad request'
}

API

HTTP Status Codes

The following status codes are available:

  • HTTP_OK (200)
  • HTTP_CREATED (201)
  • HTTP_NO_CONTENT (204)
  • HTTP_BAD_REQUEST (400)
  • HTTP_BAD_REQUEST (400)
  • HTTP_INTERNAL_SERVER_ERROR (500)
  • HTTP_INVALID_REQUEST (422)
  • HTTP_NOT_FOUND (404)
  • HTTP_UNAUTHORIZED (401)
  • HTTP_FORBIDDEN (403)

Custom Error Classes

BadRequestError

Represents a 400 Bad Request error.

class BadRequestError extends InternalServerError {
  public statusCode: number;
  constructor(message: string);
}

InternalServerError

Represents a 500 Internal Server Error.

class InternalServerError extends Error {
  public statusCode: number;
  constructor(message: string);
}

InvalidRequestError

Represents a 422 Unprocessable Entity error.

class InvalidRequestError extends InternalServerError {
  public statusCode: number;
  constructor(message: string);
}

NotFoundRequestError

Represents a 404 Not Found error.

class NotFoundRequestError extends InternalServerError {
  public statusCode: number;
  constructor(message: string);
}

UnauthorizedRequestError

Represents a 401 Unauthorized error.

class UnauthorizedRequestError extends InternalServerError {
  public statusCode: number;
  constructor(message: string);
}

ForbiddenRequestError

Represents a 403 Forbidden error.

class ForbiddenRequestError extends InternalServerError {
  public statusCode: number;
  constructor(message: string);
}

Example

Here’s an example of how to use this package in an Express application:

import express from 'express';
import { BadRequestError, NotFoundRequestError, status } from 'http-status-errors';

const app = express();

app.get('/', (req, res) => {
  res.send('Hello, world!');
});

// Return an HTTP error
app.get('/error', (req, res) => {
  try {
    throw new BadRequestError('This is a bad request');
  } catch (err) {
    res.status(err.statusCode).send(err.message)
  }
});

// Use error handling middleware
app.use((err, req, res, next) => {
  if (err instanceof BadRequestError) {
    res.status(err.statusCode).send({ error: err.message });
  } else {
    res.status(status.HTTP_INTERNAL_SERVER_ERROR).send({ error: 'An unexpected error occurred' });
  }
});

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

Contributing

Contributions are welcome! Please open an issue or submit a pull request if you would like to contribute to this project.

License

This project is licensed under the MIT License.