restify-etag-cache

Restify ETag Cache. The easy way.

Usage no npm install needed!

<script type="module">
  import restifyEtagCache from 'https://cdn.skypack.dev/restify-etag-cache';
</script>

README

restify-etag-cache

Build Status devDependency Status Dependency Status Coverage Status

Automatic middleware that enables client cache based on ETag header

Getting Started

Install the module with: npm install restify-etag-cache

Usage

It works as a middleware, so its very easy to use the library:

var restify = require('restify');
var restifyEtagCache = require('restify-etag-cache');

var server = restify.createServer();
var options = {
    ignore_routes : [ '/some/route/to/ignore/:withParam' ],
    ignore_urls : [ '/some/specific/url/to/ignore'  ],
    weak: false
};

server.use(restifyEtagCache(options)); 

Its all ;)

The server will reply HTTP status code 304 (Not Modified) when it detects that the client already have the latest content version.

Options

At this time, there are only two options available:

ignore_urls (array of urls)

ignore_routes (array of routes)

weak (boolean, set to use weak etag generation or not)

Support

IRC #kernelpanic @ irc.kernelpanic.com.ar