npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

express-cache-ctrl

v1.1.0

Published

Express middleware to handle content expiration using Cache-Control header.

Downloads

709

Readme

express-cache-ctrl

NPM version NPM Downloads Build Status Issues GitHub forks GitHub stars GitHub license

Express middleware to handle Cache-Control header, this is used by browsers with HTTP 1.1 support to know about content expiration, and when to deliver content from navigator's cache. This is a huge performance improvement when loading content from a website.

Install

$ npm install express-cache-ctrl

Basic usage

var app = express();
var cache = require('express-cache-ctrl');
app.use('/api', cache.disable());

disable()

Returns a middleware you can use on express pipeline, to disable content caching.

secure()

Returns a middleware you can use on express pipeline, to disable content caching. This method is recomended by OWASP.

private([ttl], [options])

Returns the cache middleware using the given options and ttl. This middleware sets Cache-Control scope to private.

ttl

Cache Time-To-Live in seconds or in ms() notation. e.g. 1d

Options

private() accepts these properties in the options object.

ttl

Cache ttl in seconds (max-age). Defaults to 1h.

sttl

Shared cache ttl in seconds (s-maxage). Defaults to 1h.

mustRevalidate

Boolean to specify if content must be revalidated by the browser.

proxyRevalidate

Boolean to specify if content must be revalidated by proxy servers.

noTransform

Boolean to disable header transformation.

public([ttl], [options])

Returns the cache middleware using the given options and ttl. This middleware sets Cache-Control scope to public.

ttl

Cache Time-To-Live in seconds or in ms() notation. e.g. 1d

Options

public() accepts these properties in the options object.

ttl

Cache ttl in seconds (max-age). Defaults to 1h.

sttl

Shared cache ttl in seconds (s-maxage). Defaults to 1h.

mustRevalidate

Boolean to specify if content must be revalidated by the browser.

proxyRevalidate

Boolean to specify if content must be revalidated by proxy servers.

noTransform

Boolean to disable header transformation.

custom([options])

Returns the cache middleware using the given options.

Options

custom() accepts these properties in the options object.

scope

Sets the Cache-Control scope. Either public or private.

ttl

Cache ttl in seconds (max-age). Defaults to 1h.

sttl

Shared cache ttl in seconds (s-maxage). Defaults to 1h.

mustRevalidate

Boolean to specify if content must be revalidated by the browser.

proxyRevalidate

Boolean to specify if content must be revalidated by proxy servers.

noTransform

Boolean to disable header transformation.

noCache

Disables content caching and sets header to: no-cache, no-store.

Examples

express/connect

When using this module with express or connect, simply app.use the module as high as you like. Also it can be used in any stage in any express pipeline or route.

Setting default cache to private, and 1 hour to expiration.

var express = require('express');
var cache = require('express-cache-ctrl');

var app = express();

app.use(cache.private(3600)); // 1 min.

app.get('/hello', function(req, res) {
    res.json({hello: 'world!'});
});

Setting secure cache to specific route.

var express = require('express');
var cache = require('express-cache-ctrl');

var app = express();

app.get('/hello', cache.secure(), function(req, res) {
    res.json({hello: 'world!'});
});

For more examples, you can watch out, the unit tests for this module. test/cache.js

License

MIT