Cache-layer NPM

Cache Layer

An abstraction for cache providers, it exposes a common interface for different ways to cache data

It suports

Redis - luin/ioredis
MemCached - 3rd-Eden/memcached
In memory - ptarjan/node-cache

Sumary

Installation

$ npm install cache-layer --save

API

get

Retrieves a value for a given key

put

Store a value for a given key
If time isn't passed in, it is stored forever

del

Delete value for a given key

has

Check if key exists on cache

Usage

InMemory

const client = Cache.create({
  provider: 'in-memory',
  ttl: 2000 // a defautt TTL (miliseconds)
});

MemCached

To use memcached you have to inform a server or it will set a localhost as default. So, to use it locally, you need to install memcached. If you have a memcached server, just inform the host

sudo apt-get install memcached

const client = Cache.create({
  host: 'localhost:11211' // if any host was informed, it will set localhost as default
  provider: 'memcached',
  ttl: 2000 // a defautt TTL (miliseconds)
});

Options

All available options to create memcached instance: https://raw.githubusercontent.com/3rd-Eden/memcached/master/README.md

Redis

const client = Cache.create({
  provider: 'redis',
  host: 'redis.com.br',
  container: 'cache',
  port: 6379,
  ttl: 2000, // a defautt TTL (miliseconds)
  keyPrefix: 'cache:',
  lazyConnect: true,
  maxRetriesPerRequest: 0
});

The TTL is in ms, you can pass a default value, or add as a third parameter on add method. The package implements zeit/ms, so is possible to use a string to define the TTL with zeit/ms format

const done = await client.add('hashKey', { name: 'John' }, 1000);
const result = await client.get('hashKey');

const done = await client.add('hashKey', { name: 'John' }, '1s');
const result = await client.get('hashKey');

const done = await client.add('hashKey', { name: 'John' }, '1d');
const result = await client.get('hashKey');