delta-cache

Node server-side support for RFC 3229 delta encoding


Keywords
encoding, rfc, 3229, caching, change, encode
License
MIT
Install
npm install delta-cache@0.1.1

Documentation

delta-cache-express

Express middleware for server support for delta caching

Designed to work with delta-cache-browser. Note that HTTPS is required if you're using that library.

Complies with the RFC 3229 delta encoding spec with googlediffjson encoded deltas.

Getting Started

var DeltaCache = require('delta-cache-express');
var express = require('express');

var deltaCache = DeltaCache();
var app = express();
app.get('/dynamicContent', function(req, res, next) {
  // put your response body in this variable for DeltaCache to find
  res.locals.responseBody = new Date().toString();
  next();
}, deltaCache);

Function: DeltaCache

Returns a middleware function deltaCache that acts on a cache instance.

deltaCache(req, res, next)

Inspects request for delta compatibiliy and uses res.locals.responseBody as the target for the client to produce. Sends either a 200, 304, or 226 response (see RFC 3229 for more information).