Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    errorfacepublic

    ☺ errorface

    Express middleware for showing detailed error information when errors happen in your app.

    Inspired by phperror.net.

    Build Status

    Example

    Visit the example error page to see it in action.

    Installation

    npm install errorface
    

    Usage

    var express = require("express"),
        errorface = require("errorface");
    
    var app = express();
    
    app.get("/", function(req, res, next) {
        res.send("Hello World");
    });
    
    app.get("/error", function(req, res, next) {
        app.doesntExist();
    });
    
    app.get("/*", function(req, res) {
        throw new Error("Not Found");
    });
    
    app.use(errorface.errorHandler());
    
    app.listen(3000);
    

    Advanced Usage

    You can extend the middleware with a couple options, here are the defaults:

    // Default options
    var options = {
        // Output to console.log
        log: console.log,
        // We don't output errors to log unless you want to
        logErrors: false,
        // We return html response page if requested
        disableHtml: false,
        // We return json response if requested
        disableJson: false,
        // Pass a function (or a true/false value) to determine whether the error page should be shown
        showPage: function(err, req) {
            return true;
        },
        // We use Mustache to render templates by default
        templateFunc: Mustache.render,
        // You can pass a string in as a template
        errorPageTemplate: null,
        // Or, you can pass a path to a file to use as the template
        errorPageTemplatePath: __dirname + "/views/errorPage.stache",
        // If you want to twiddle with the data before it gets sent to the template
        preProcessTemplateData: function(data) { return data; }
    };
    
    // Just pass them to the errorHandler when you register with your express app
    app.use(errorface.errorHandler(options));
    

    Custom Templating

    Here is an example of the data that gets sent to the template in case you want to create your own.

    {
       "headLine":{
          "type":"description",
          "details":{
             "error":"Error",
             "message":"Not Found"
          }
       },
       "stack":[
          {
             "level":1,
             "trace":{
                "type":"file",
                "details":{
                   "method":"init",
                   "file":"''/projects/errorface/test/util/testServer.coffee",
                   "fileHash":"2c57b3f110c76c5348e3e03296430f6b",
                   "fileRelative":"/test/util/testServer.coffee",
                   "line":18,
                   "column":13
                }
             },
             "focused":"throw new Error(\"Not Found\");",
             "file":[
                {
                   "num":14,
                   "isFocus":false,
                   "line":"    app.get(\"/error\", function(req, res, next) {"
                }
             ]
          }
       ],
       "lines":[
          {
             "type":"description",
             "details":{
                "error":"Error",
                "message":"Not Found"
             }
          },
          {
             "type":"file",
             "details":{
                "method":"init",
                "file":"''/projects/errorface/test/util/testServer.coffee",
                "fileHash":"2c57b3f110c76c5348e3e03296430f6b",
                "fileRelative":"/test/util/testServer.coffee",
                "line":18,
                "column":13
             }
          },
          {
             "type":"file",
             "details":{
                "method":"callbacks",
                "file":"''/projects/errorface/node_modules/express/lib/router/index.js",
                "fileHash":"ba7d97ee1f59f2aa0920257deb060e46",
                "fileRelative":"[module]/express/lib/router/index.js",
                "line":162,
                "column":11
             }
          }
       ],
       "projectDirectory":"''/projects/errorface"
    }
    

    License

    Copyright 2012 Jacob Gable, MIT License; no attribution required.

    install

    npm i errorface

    Downloadsweekly downloads

    27

    version

    0.1.2

    license

    MIT

    repository

    githubgithub

    last publish

    collaborators

    • avatar