💶 💷 Cache Out 💵 💴

Cache out is simple tool to use in place of your service requests that will cache service responses for a specified time so all your users don't have to have a bad day because one of your services is.

It is backed by Redis so you will have to have a Redis instance running for this work. It also uses ES6, ioredis and returns a promise!

Install:

npm i cache-out --save

API:

cache-out(requestMethod, requestOptions, [redisOptions], [secondsToCache])

Calls your requestMethod with the requestOptions and caches the response in redis for the secondsToCache. If something goes wrong it's just a call through to your request.

| Param | Type | Default | Description | | --- | --- | --- | --- | | requestMethod | function | required | the function that you would be replacing cache-out with (ex request-promise-native) | | requestOptions | object | required | the options object you would be passing to the function above | | redisOptions | object | If no argument is passed a default ioredis client will be created | this is not required but if you want to specify you're redis setup (which you definitely are going to have to do at some point) then make sure it follows the options object specified for ioredis. Alternatively, you can pass in a pre instantiated redis client here too! Cache-out will use the passed in client if this is the case. | | secondsToCache | number | 86400 (which 24 hours in seconds) | The amount of time in seconds you want to cache the response in redis for |

Example usage:

const cacheOut = require('cache-out');
const request = require('request-promise');
const requestOpts = {url: 'http://www.url.com/uncool/why/', method: 'GET'};
const redisConfig = {port: 6379, host: 'localhost', db: 0, password: ''};

cacheOut(request, requestOpts, redisConfig, 604800)
  .then((res) => console.log('Wow, that was fast! ', res));
  
//
// This is also valid!
//

const cacheOut = require('cache-out');
const request = require('request-promise');
const requestOpts = {url: 'http://www.url.com/uncool/why/', method: 'GET'};
const ioredis = require('ioredis');
const redisClient = new ioredis({port: 6379, host: 'localhost', db: 0, password: ''});

cacheOut(request, requestOpts, ioredis, 604800)
  .then((res) => console.log('Nice, you used your own redis client! ', res));
  
//
// Don't worry, you can also use cache-out without ioredis!
//

const cacheOut = require('cache-out');
const request = require('request-promise');
const requestOpts = {url: 'http://www.url.com/uncool/why/', method: 'GET'};
const redis = require('redis');
const redisClient = redis.createClient({port: 6379, host: 'localhost', db: 0, password: ''});

cacheOut(request, requestOpts, ioredis, 604800)
  .then((res) => console.log('Nice, you are not using ioredis! ', res));

Testing:

I recommend using a mock redis client and passing this into cache-out if your NODE_ENV === 'test'.

Thanks! 🐕