hotcache

HOTCACHE

A classic problem: the cold cache. Your application was just deployed, moments ago. Immediately it's being hit by many requests, but since the cache is empty (or "cold"), every request has to go the expensive route before it can be put in cache.

This module is a simple cache that alleviates the problem. It's async-, promise- and error-aware and it will only fetch something once when the cache is cold. Concurrent requests will be queued up and resolved when the fetch comes back with a value. In case of errors, the queued up elements are resolved, but the result is not cached.

It has the simplest API you've seen.

Install

Node

npm install hotcache

Browser

bower install hotcache

or

<script type="text/javascript" src="hotcache.min.js"></script>

Example

var Hotcache = require("hotcache") //Node only

// First create a cache
var cache = new Hotcache()
// Then access elements in it
cache.get("someKey", 5000, myAsyncFunction, arg1, arg2, argN, cb)

If "someKey" already exists in the cache, it'll be returned to the callback immediately and myAsyncFunction will not be executed. If it's not in the cache, myAsyncFunction will be executed with the listed arguments and the result will be passed to cb. If that call was successful (meaning that it didn't pass an error to cb as its first argument), then the result will be cached for the specified number of milliseconds (5000 in this example).

Note: Make sure to pass a callback (cb), even if it's just an empty function.

Note: There can be from zero to as many arguments as needed.

That's it. It solves a very simple problem elegantly. Does one thing and does it well.

This is an adaptation of the original written in OCaml, which you can view here.

Promise support

Version 1.0 brings support for Promises.

var Hotcache = require("hotcache") //Node only

// First create a cache
var cache = new Hotcache()
// Then access elements in it
cache.pget("someKey", 5000, myFunction, arg1, arg2, argN) // Returns a Promise object

Examples

// Both of these are valid:

cache.pget("my_key", 1000, (function(someParameter){
  return "some value" // A naked value
}), "some parameter")
.then(function(res){
  // res === "some value"
})
.catch(function(err){
  // log possible errors
})

cache.pget("my_key", 1000, (function(someParameter){
  return Promise.resolve("some value") // A Promise
}), "some parameter")
.then(function(res){
  // res === "some value"
})
.catch(function(err){
  // log possible errors
})

Non-promise return values are wrapped in a Promise. Errors that happen inside the function are wrapped in a failed Promise.

It uses the bluebird package if installed and otherwise uses the built-in Promise object.

You can use a different Promise library by passing it by reference to the constructor:

var cache = new Hotcache(myPromiseLibrary)