Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

express-err

Package Overview
Dependencies
1
Maintainers
1
Versions
7
Issues
File Explorer

Advanced tools

express-err

Basic error handler for express.

    3.0.0latest

Version published
Maintainers
1
Yearly downloads
49,954
increased by5.24%

Weekly downloads

Changelog

Source

3.0.0 (2019-08-28)

⚠ BREAKING CHANGES

  • requires node v8+

Features

Readme

Source

express-err

Build Status Dependency Status devDependency Status

Basic error handler for express. This middleware shows errors according to the "Accept" header. It will shutdown app in case of uncaught error.

Install

yarn add express-err

Usage

import express from 'express' import errorHandler, { httpError } from 'express-err' const app = express() // Basic route. app.get('/', (req, res) => { res.send('Hello world!') }) // Redirect other routes to 404. app.use(httpError(404)) // Handle errors. app.use(errorHandler())

errorHandler(options)

The error handler middleware is used to display errors and shutdown app in case of uncaught error.

The avalaible options are:

exitOnUncaughtException

Tell to the process to exit on uncaught exceptions. Defaults to true.

app.use(errorHandler({ exitOnUncaughtException: false }))

exitCode

The code used to exit app in case of uncaught exception. Defaults to 1.

app.use(errorHandler({ exitCode: 2 }))

defaultStatusCode

The default HTTP error code. Defaults to 500.

app.use(errorHandler({ status: 503 }))

formatters

The error handler come with some preconfigured formatters, one for "json", "text" and "html". It's possible to provide your own formatters:

import { text } from 'express-err/lib/formatters' app.use( errorHandler({ formatters: { json(err, req, res, next) { res.send({ error: true }) }, default: text, }, }), )

httpError(status, [message])

You can use httpError to return a custom error with a status and a message, if you don't provide a message, it will automatically use the HTTP status.

import { httpError } from 'express-err' app.use(httpError(404))

new HttpError(status, [message])

You can create a custom HttpError with a status and a message, if you don't provide a message, it will automatically use the HTTP status.

import { HttpError } from 'express-err' app.use((req, res, next) => { next(new HttpError(404, 'Bad way')) })

License

MIT

Keywords

Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc