JSPM

apology-middleware

0.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 10
  • Score
    100M100P100Q38003F
  • License MIT

middleware for custom error pages

Package Exports

  • apology-middleware

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (apology-middleware) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Apology Middleware

npm tests dependencies

Middleware for custom error pages

Note: This project is in early development, and versioning is a little different. Read this for more details.

Why should you care?

Let's say that you are using connect to serve a static site. Occasionally, and by no fault of yours of course, some one may request a URL that you don't have. Your app will gladly return a 404 code for you, but sometimes that's not enough. Apology Middleware is for those times when you want to serve a custom HTML document for those pesky 404s.

Installation

npm install apology-middleware --save

Usage

This library can be used with connect, express, and any other server stack that accepts the same middleware format. A very basic usage example:

var http = require('http');
    connect = require('connect'),
    apology = require('apology-middleware'),
    static  = require('serve-static');

var app = connect()

app.use(apology('/path/to/4oh4.html')
app.use(static());

var server = http.createServer(app).listen(1111)

As you can see, you can simply pass an error_page object that's value points to the file you wish to serve. If you don't specify an error_page or point to one that doesn't exist (404-ception, whoa) then apology will serve our standard error file (don't worry, it's quite handsome).

License & Contributing