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

hapi-redis-output-cache

v3.0.0

Published

Redis-backed output cache plugin for Hapi

Downloads

11

Readme

hapi-redis-output-cache

Redis-backed output cache plugin for Hapi

Build StatusDependency Status NPM version

NPM

Usage

$ npm i hapi-redis-output-cache --save
var server = new (require('hapi').Server)();
server.connection({ port: 3000 });

server.register([
    {
        register: require('hapi-redis-output-cache'),
        options: {
            host: '127.0.0.1',
            staleIn: 30,
            expiresIn: 60
        }
    }
], function (err) {
    if (err) {
        console.error('Failed to load plugin:', err);
    }

    server.start();
});

Configuration

  • host - hostname or IP address of the Redis server
  • port - (optional) port of the Redis server; defaults to 6379
  • varyByHeaders - (optional) an array of headers to be used for generating cache key; defaults no none
  • partition - (optional) string to prefix cache keys with, useful for shared redis instances
  • staleIn - number of seconds until the cached response will be considered stale and marked for regeneration
  • expiresIn - number of seconds until the cached response will be purged from Redis
  • onCacheMiss - (optional) function(req, reply){ ... } invoked on each cache write; useful for responding to cache miss events

Route Settings

By default, output caching is disabled. To enable it for a specific route, set isCacheable: true in the route settings:

server.route({
    method: 'GET',
    path: '/',
    handler: function (request, reply) {
        return reply('hello world');
    },
    config: {
        plugins: {
            'hapi-redis-output-cache': {
                isCacheable: true
            }
        }
    }
});

Miscellaneous

Output cache metadata is injected into each request and can be access via req.outputCache:

  • isStale: boolean value indicating whether the cache is stale
  • data: object representing cached response (available even when stale)

Release History

  • v3.0.0 (2015-07-11)
    • breaking changes:
      • require node >4
      • require hapi >8
      • new key generation algorithm will invalidate existing keys
      • removed onError hook
  • v2.0.2 (2015-07-22)
    • fixed caching bug
  • v2.0.1 (2015-07-13)
    • updated dependencies
  • v2.0.0 (2015-04-10)
    • added partition option
  • v1.0.3 (2015-03-31)
    • bug fixes
  • v1.0.0 (2015-03-30)
    • implemented a more sophisticated freshness mechanism which allows stale and expired data to be handled separately
    • implemented a whitelist of request headers to be used for generating cache key to provide more fine-grained control over keys
  • v0.2.1 (2015-03-30)
    • fixed handling of responses with failed joi validation
  • v0.2.0 (2015-03-30)
    • fixed cache key algorithm
  • v0.1.0 (2015-03-29)
    • initial release