cache-wrapper's Introduction

cache-wrapper

About

A simple wrapper for catbox cache, that uses redis if serverConfig is not empty and memory when serverConfig is an empty object. This also offers queueing for requests if the connection to the cache server has dropped.

Getting Started

You can start with cloning down the repo

$ git clone [email protected]:holidayextras/cache-wrapper

After you will need to install its dependencies

$ npm install

or to install this module to your project

npm install github.com/holidayextras/cache-wrapper --save

Implementation

You must first initialise the cache and pass in the server configuration and your cache policies. You can then get and set your cache keys to your hearts content;

var cache = require( 'cache-wrapper' );

var serverConfig = {
	host: 'cache-production.t-bob.co.uk',
	port: 11211,
	partition: 'theWorks'
};

var cachePolicies = [
	{
		segment: 'myCacheSegment',
		expiresIn: 10000
	},
	{
		segment: 'myOtherCacheSegment',
		expiresIn: 300000
	}
];
cache.initialise( serverConfig, cachePolicies ).then( function() {
	cache.set( {
		segment: 'BobHoskinsFacts',
		key: 'Height',
		value: '5.5 feet'
	} ) .then( function() {
		cache.get( {
			segment: 'BobHoskinsFacts',
			key: 'Height'
		} ).then( console.log );	//OUTPUTS: "5.5 feet"
	} );
} );