@types/http-errors

What is @types/http-errors?

The @types/http-errors package provides TypeScript type definitions for the http-errors package, which is used to create HTTP error objects. These type definitions allow TypeScript developers to use the http-errors package in a type-safe manner, ensuring that they are using the correct types for the various functions and constructors provided by http-errors.

What are @types/http-errors's main functionalities?

Creating HTTP Error Objects

This feature allows developers to create HTTP error objects with a status code and message. The example demonstrates creating a 404 Not Found error.

import createError from 'http-errors';

const NotFoundError = createError(404, 'This page does not exist.');
console.log(NotFoundError.status); // 404
console.log(NotFoundError.message); // 'This page does not exist.'

Type Checking for HTTP Error Objects

This feature provides type definitions for handling HTTP errors in a type-safe way. The example shows a function that accepts an HttpError object, demonstrating the use of TypeScript for type checking.

import createError, { HttpError } from 'http-errors';

function handleError(error: HttpError) {
  console.log(error.status);
  console.log(error.message);
}

const myError = createError(500, 'Internal Server Error');
handleError(myError);

Other packages similar to @types/http-errors

http-errors

This is the JavaScript library that @types/http-errors provides TypeScript definitions for. It allows for the creation of HTTP error objects but does not include built-in type definitions.

boom

Boom provides a set of utilities for returning HTTP errors. Each utility returns a Boom error response object (including status code and message), similar to http-errors but with more features like payload formatting.

README

Installation

npm install --save @types/http-errors

Summary

This package contains type definitions for http-errors (https://github.com/jshttp/http-errors).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/http-errors.

Additional Details

• Last updated: Sat, 16 Sep 2023 08:06:32 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Tanguy Krotoff, and BendingBender.