cache-manager-express-mw

cache-manager-express-mw

Middleware for Express that uses cache-manager to add a caching layer in front of your application.

Features

• cache-manager is a robust caching solution for node that provides a number of features.
• Uses HTTP/1.1 Cache-Control header to control the cache behavior.
• Cache keys are autogenerated based on the HTTP method and route to ensure consistency.

Installation

npm install cache-manager-express-mw

Examples

You can register the middleware globally using app.use().

var cacheManager = require("cache-manager");
var cache = cacheManager.caching({ store: "memory" });

var cacheManagerExpress = require("cache-manager-express-mw");
app.use(cacheManagerExpress(cache));

Alternatively, you register the middleware with a specific route to allow for different routes to use different caching mechanisms and options:

app.get("/", cacheManagerExpress(cache), function(req, res) {
  // ...
});

In addition to the cache, you can pass in a options object to control the behavior of the middleware:

var cacheManagerExpress = require("cache-manager-express-mw");
app.use(cacheManagerExpress(cache, { prefix: "MyApp" }));

A fully functional sample app is available in this repository under the sample directory.

Options

Property	Default	Description
prefix	undefined	A prefix to append to the front of the generated cache key in case differentiation is needed.
defaults	undefined	An object containing query string default values so that a missing query string value and the specified default resolve to the same cache key. For example, { defaults: { val: "abc" } } will ensure that the routes /a/b/c and /a/b/c?val=abc resolve to the same cache key.

License

MIT