hapi-error-page

Friendly error pages for humans

This hapi plugin makes it easy to return beautiful HTML error pages to your users.

Why?

• Errors in hapi are displayed as JSON by default.
• JSON is good for machines but bad for people.
• Works with AJAX / APIs (respects the Accept header).

Install

npm install hapi-error-page

Usage

Register the plugin on your server to enable friendly error pages.

const hapi = require('@hapi/hapi');
const vision = require('@hapi/vision');
const errorPage = require('hapi-error-page');

const server = hapi.server();

const init = async () => {
    await server.register([vision, errorPage]);
    server.views({
        engines    : { html : handlebars },
        relativeTo : __dirname,
        path       : '.'
    });
    server.route({
        method : 'GET',
        path   : '/',
        handler() {
            throw new Error('uh oh');
        }
    });
    await server.start();
    console.log('Server ready:', server.info.uri);
};

init();

Visiting the above route will return an HTML error page rendered by Handlebars from a view file named error.html. You can, of course, use other templating engines instead (see the vision documentation for details).

Please use boom to construct errors instead of new Error(), so that we can deliver more useful messages. This project will function correctly either way, but boom is preferred.

Contributing

See our contributing guidelines for more details.

1. Fork it.
2. Make a feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request.

License

MPL-2.0 © Seth Holladay

Go make something, dang it.