@forgerock/openam-agent-cache-memcached
v2.0.0
Published
Cache using Memcached for the OpenAM Policy Agent for NodeJS
Downloads
5
Maintainers
Keywords
Readme
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
| 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
DISCLAIMER
The sample code described herein is provided on an "as is" basis, without warranty of any kind, to the fullest extent permitted by law. ForgeRock does not warrant or guarantee the individual success developers may have in implementing the sample code on their development platforms or in production configurations.
ForgeRock does not warrant, guarantee or make any representations regarding the use, results of use, accuracy, timeliness or completeness of any data or information relating to the sample code. ForgeRock disclaims all warranties, expressed or implied, and in particular, disclaims all warranties of merchantability, and warranties related to the code, or any service or software related thereto.
ForgeRock shall not be liable for any direct, indirect or consequential damages or costs of any type arising out of any action taken by you or others related to the sample code.