openam-agent-cache-memcached
Cache using Memcached for the OpenAM Policy Agent for NodeJS
Installation: npm install openam-agent-cache-memcached
API Docs
Cache
MemcachedCache ⇐ 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
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
});
Promise
memcachedCache.get(key) ⇒ 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);
});
Promise
memcachedCache.put(key, value) ⇒ 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);
});
Promise
memcachedCache.remove(key) ⇒ 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);
});
Promise
memcachedCache.quit() ⇒ Closes the client connection
Kind: instance method of MemcachedCache