@forgerock/openam-agent-cache-memcached

Cache using Memcached for the OpenAM Policy Agent for NodeJS


License
MIT
Install
npm install @forgerock/openam-agent-cache-memcached@2.0.0

Documentation

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

new MemcachedCache([options])

Cache implementation for memcached

Param Type Default Description
[options] object Options
[options.url] string "http://localhost/11211" memcached URL
[options.expireAfterSeconds] number 60 Expiration time in seconds

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

Param Type
key string

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

Param Type
key string
value *

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

Param Type
key string

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