JSPM

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

Trailing slash redirect middleware for Connect and Express.js

Package Exports

  • connect-slashes

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 (connect-slashes) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

connect-slashes

Trailing slash redirect middleware for Connect and Express.js. Useful for creating canonical urls in your Node.js applications.

Installation

$ npm install connect-slashes

Usage

var connect = require("connect")
  , slashes = require("connect-slashes");

connect() // or express()
  .use(connect.static())
  .use(slashes()) // must come after static middleware!
  .listen(3000);

Alternatively, you can pass false as the first argument to .slashes() in order to remove trailing slashes instead of appending them:

.use(slashes(false));

Additional settings

You can also pass a second argument with an options object. For example, if an application is behind a reverse proxy server that removes part of the URL (a base_path) before proxying to the application, then the base can be specified with an option:

.use(slashes(true, { base: "/blog" })); // prepends a base url to the redirect

By default, all redirects are using the 301 Moved Permanently header. You can change this behavior by passing in the optional code option:

.use(slashes(true, { code: 302 })); // 302 Temporary redirects

You can also set additional headers to the redirect response with the headers option:

.use(slashes(true, { headers: { "Cache-Control": "public" } }));

Notes

  1. Only GET, HEAD, and OPTIONS requests will be redirected (to avoid losing POST/PUT data)
  2. This middleware will append or remove a trailing slash to all request urls. This includes filenames (/app.css => /app.css/), so it may break your static files. Make sure to .use() this middleware only after the connect.static() middleware.

LICENSE

MIT