Newtonian Physics Mockumentary
Miss any of our Open RFC calls?Watch the recordings here! »

uber-cache-helpers

0.1.0 • Public • Published

uber-cache-helpers

The aim of uber-cache-helpers is to give a set of tools that lets the user choose a backend store directly from its application configuration.

Available backends

We have four backends at the moment:

  • Memory
  • Redis
  • Mongodb
  • Memcached

Configure the Memory backend

var options = {"engine": "memory"};

Configure the Redis backend

var options = {
  "engine": "redis",
  "settings": {
    "port": 6379,
    "host": "127.0.0.1",
    "db": "0"
  }
};

These are default values, so you can also simply use:

var options = {"engine": "redis"};

Configure the Memcached backend

var options = {
  "engine": "memcached",
  "settings": {
    "serverLocations": ["127.0.0.1:11211"]
  }
};

These are default values, so you can also simply use:

var options = {"engine": "memcached"};

Configure the MongoDB backend

var options = {
  "engine": "mongodb",
  "settings": {
    "collectionName": "testCollection",
    "connectionString": "mongodb://127.0.0.1:27017/uberCache"
  }
};

Get your Uber-Cache instance from the configuration

The aim of all of this is to be able to change the configuration and just have the same Uber-Cache API for all of them.

var getCacheBackend = require("uber-cache-helpers").getCacheBackend;
 
var cache = getCacheBackend(options);
 
cache.set("the key", "the value", function () {
  cache.get("the key", function (error, value) {
    console.log(value);
  });
});

And that's just it!

You can also get access directly to then engine using cache.engine:

cache.engine.close();

Keywords

none

Install

npm i uber-cache-helpers

DownloadsWeekly Downloads

1

Version

0.1.0

License

BSD

Last publish

Collaborators

  • avatar