openam-agent-cache-memcached v1.0.1

openam-agent-cache-memcached

Cache using Memcached for the OpenAM Policy Agent for NodeJS

Installation: npm install openam-agent-cache-memcached

API Docs

MemcachedCache ⇐ Cache

Kind: global class
Extends: Cache

• MemcachedCache ⇐ Cache
  • new MemcachedCache([options])
  • .get(key) ⇒ Promise
  • .put(key, value) ⇒ Promise
  • .remove(key) ⇒ Promise
  • .quit() ⇒ Promise

new MemcachedCache(options)

Cache implementation for memcached

Example

var memcachedCache = new MemcachedCache({
  url: 'cache.example.com:11211',
  expireAfterSeconds: 600
});

memcachedCache.get(key) ⇒ Promise

Get a single cached item If the entry is not found, reject

Kind: instance method of MemcachedCache

Example

memcachedCache.get('foo').then(function (cached) {
  console.log(cached);
}).catch(function (err) {
  console.error(err);
});

memcachedCache.put(key, value) ⇒ Promise

Store a single cached item (overwrites existing)

Kind: instance method of MemcachedCache

Example

memcachedCache.put('foo', {bar: 'baz'}).then(function () {
  console.log('foo saved to cache');
}).catch(function (err) {
  console.error(err);
});

memcachedCache.remove(key) ⇒ Promise

Remove a single cached item

Kind: instance method of MemcachedCache

Example

memcachedCache.remove('foo').then(function () {
  console.log('foo removed from cache');
}).catch(function (err) {
  console.error(err);
});

memcachedCache.quit() ⇒ Promise

Closes the client connection

Kind: instance method of MemcachedCache