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

route-cache

v0.7.0

Published

express middleware for caching your routes

Downloads

157,222

Readme

Route-Cache

Blazing fast :bullettrain_side: Express middleware for route caching with a given TTL (in seconds)

Build Status NPM Version Downloads

NPM js-standard-style

Why?

  • makes hard-working routes super-fast, under heavy-load, see Load Tests
  • defend against 'thundering herd'
  • supports various content-types
  • support for redirects
  • allows for conditional caching (per request)
  • works with gzip compression

Install

npm install route-cache

Test

npm test

How to use

var routeCache = require('route-cache');

// cache route for 20 seconds
app.get('/index', routeCache.cacheSeconds(20), function(req, res){
  // do your dirty work here...
  console.log('you will only see this every 20 seconds.');
  res.send('this response will be cached');
});

By default req.originalUrl is used as the cache key so every URL is cached separately.

You can set a custom key by passing a second argument to cacheSeconds.

routeCache.cacheSeconds(20, 'my-custom-cache-key')

You can set a dynamic key from the req and res objects by passing a function.

// Cache authenticated and unauthenticated responses separately
routeCache.cacheSeconds(20, function(req, res) {
  return req.originalUrl + '|' + res.locals.signedIn
})

If you return false the response will not be cached.

// Only cache unauthenticated responses
routeCache.cacheSeconds(20, function(req, res) {
  if (res.locals.signedIn) { return false }

  return req.originalUrl
})

Delete a cached route

routeCache.removeCache('/index');

Use a distributed cache

const Redis = require('ioredis')
const IoRedisStore = require('route-cache/ioRedisStore')


const redisClient = new Redis(6379, '127.0.0.1'))
const cacheStore = new IoRedisStore(redisClient)
routeCache.config({cacheStore})

Future plans / todos

  • client-side Cache-Control

The MIT License (MIT)

Copyright (c) 2014 Brad Oyler

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.