@meanie/express-error-handling

Error handlers and middleware for use in Express projects

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
20Jun 28, 2020Jul 17, 2016Minified + gzip package size for @meanie/express-error-handling in KB

Readme

@meanie/express-error-handling

npm version node dependencies github issues codacy

Error handlers and middleware for use in Express or Meanie Express Seed projects

Meanie

Installation

You can install this package using yarn or npm.

#yarn
yarn add @meanie/express-error-handling

#npm
npm install @meanie/express-error-handling --save

Configuration

//Load library
const errors = require('@meanie/express-error-handling');

//Define some custom middleware
const myHandler = function(error, req, res, next) { ... };

//Register it with the error handler
errors.register('my-handler', myHandler);

//Specify default middleware stack to use
errors.use([
  'normalize', 'track-with-sentry', 'my-handler', 'log-to-console',
]);

Usage

Load stack of pre-registered error handling middleware:

const stack = errors.middleware();

Use it as express middleware:

stack.forEach(handler => app.use(handler));

Run an error through error handling middleware stack:

someRoute(req, res, next) {
  doSomething()
    .then(() => {

      //End response
      res.end();

      //Do something else async which won't be part of the request
      //error handling stack, but catch and process the errors anyway.
      doSomethingElse()
        .catch(error => errors.handler(error, req));
    })
    .catch(next);
}

Issues & feature requests

Please report any bugs, issues, suggestions and feature requests in the @meanie/express-error-handling issue tracker.

Contributing

Pull requests are welcome! If you would like to contribute to Meanie, please check out the Meanie contributing guidelines.

Sponsor

This package has been kindly sponsored by Hello Club, an all in one club and membership management solution complete with booking system, automated membership renewals, online payments and integrated access and light control. Check us out if you happen to belong to any kind of club or if you know someone who helps run a club!

License

(MIT License)

Copyright 2016-2020, Adam Reis

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.