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

itp-express-redis-cache

v1.3.1

Published

A light api route cache system with Redis for Express

Downloads

8

Readme

ITP Express Redis Cache

NPM version MIT License

A light api route cache system with Redis for Express.js

Installation

npm install itp-express-redis-cache

Usage

const express = require('express');
const app = express();

const ITPExpressRedisCache = require('itp-express-redis-cache')();

app.get('/', ITPExpressRedisCache.route(), (req, res) => {
  res.json({ foo: 'bar' });
});

app.listen(3000, () => {
  console.log('Example app listening on port 3000!');
});

Options

Init options:

const ITPExpressRedisCache = require('itp-express-redis-cache')({
  port: 6379, // redis port
  host: 'localhost', // redis host
  authPass: null, // redis pass
  db: 0, // redis database id
  prefix: 'my-sample-app', // redis key prefix, e.g. 'my-sample-app:route:GET:/'
  enabled: true, // disable/enable route caching, for example in debug mode
  excludeStatuscodes: 500, // disable response caching based on response statuscode. Possible values: number, array, function (excludes 500 and higher by default)
});

The excludeStatuscodes parameter can also be an array:

const ITPExpressRedisCache = require('itp-express-redis-cache')({
  port: 6379,
  host: 'localhost',
  authPass: null,
  db: 0,
  prefix: 'my-sample-app',
  enabled: true,
  excludeStatuscodes: [404, 406, 408, 410], // disable response caching based on response statuscode. Possible values: number, array, function (excludes 500 and higher by default)
});

Route middleware options:

ITPExpressRedisCache.route({
  key: 'custom-redis-key-for-route', // custom redis key
  expire: 120, // expiration time in seconds
})

The route key parameter can also be a function:

ITPExpressRedisCache.route({
  key: (req) => `custom-key:${req.originalUrl}`, // custom function
  expire: 120, // expiration time in seconds
})

The expire parameter can also be a function:

ITPExpressRedisCache.route({
  key: (req) => `custom-key:${req.originalUrl}`, // custom function
  expire: (req) => 120 + 4, // expiration time in seconds
})

Application-level middleware

Simply use app.use of express to use ITPExpressRedisCache as an Application-level middleware.

app.use(ITPExpressRedisCache.route())

Disable Caching inside the Route

You can disable caching for specific routes by adding res.skipCache = true to opt out the route from getting cached.

app.get('/:paramKey', (req, res) => {
    res.skipCache = paramKey === 1300;
    res.send('Hello');
});

Supported env variables

  • REDIS_HOST
  • REDIS_PORT
  • REDIS_PASS
  • REDIS_DB

License

ITP-Express-Redis-Cache is freely distributable under the terms of the MIT license.