errorface - npm Package Compare versions
Comparing version 0.0.2 to 0.0.21
| { | ||
| "name": "errorface", | ||
| "version": "0.0.2", | ||
| "version": "0.0.21", | ||
| "description": "Shows a styled error page while developing your app.", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -20,23 +20,24 @@ ☹ errorface | ||
| express = require "express" | ||
| errorface = require "errorface" | ||
| var express = require("express"), | ||
| errorface = require("errorface"); | ||
| # Create your express app | ||
| app = express() | ||
| var app = express(); | ||
| # Register your routes | ||
| app.get "/", (req, res) -> | ||
| res.send "Hello World" | ||
| app.get "/error", (req, res, next) -> | ||
| app.doesntExist() | ||
| app.get "/*", (req, res) -> throw new Error("Not Found") | ||
| # Register the errorHandler middleware after your routes. | ||
| app.use errorface.errorHandler() | ||
| app.get("/", function(req, res, next) { | ||
| res.send("Hello World"); | ||
| }); | ||
| # Start your app | ||
| app.listen 3000 | ||
| 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 | ||
@@ -46,22 +47,29 @@ | ||
| # Default options | ||
| options = | ||
| # Output to console.log | ||
| log: console.log | ||
| # We don't output errors to log unless you want to | ||
| logErrors: false | ||
| # 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: (data) -> data | ||
| // Default options | ||
| var options = { | ||
| // Output to console.log | ||
| log: console.log, | ||
| // We don't output errors to log unless you want to | ||
| logErrors: 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) | ||
| // Just pass them to the errorHandler when you register with your express app | ||
| app.use(errorface.errorHandler(options)); | ||
| Here is an example of the data that gets sent to the template | ||
| ## Custom Templating | ||
| Here is an example of the data that gets sent to the template in case you want to create your own. | ||
| { | ||
@@ -131,2 +139,6 @@ "headLine":{ | ||
| "projectDirectory":"''/projects/errorface" | ||
| } | ||
| } | ||
| ## License | ||
| Copyright 2012 Jacob Gable, MIT License; no attribution required. |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.36%
73499
- Number of lines in readme file
- increased by9.3%
141
- Number of medium supply chain risk alerts
- decreased by-100%
0