isabella232 / node-openam-agent-cache-redis

Cache using Redis for the OpenAM Policy Agent for NodeJS

openam-agent-cache-redis

Cache using Redis for the OpenAM Policy Agent for NodeJS

Installation: npm install @forgerock/openam-agent-cache-redis

API Docs

RedisCache ⇐ Cache

Kind: global class
Extends: Cache

• RedisCache ⇐ Cache
  • new RedisCache([options])
  • instance
    • .get(key) ⇒ Promise
    • .put(key, value) ⇒ Promise
    • .remove(key) ⇒ Promise
    • .quit() ⇒ Promise
  • static
    • .PREFIX : string

new RedisCache([options])

Cache implementation for redis

Param	Type	Default	Description
[options]	object		Options
[options.url]	string	"redis://localhost/6379"	redis URL
[options.expireAfterSeconds]	number	60	Expiration time in seconds
[options.redis]	* | undefined		Redis options (see https://www.npmjs.com/package/redis)

Example

var redisCache = new RedisCache({
  url: 'redis://cache.example.com:6379',
  expireAfterSeconds: 600,
  redis: {
     retry_strategy: function (options) {
         // do stuff
     }
  }
});

redisCache.get(key) ⇒ Promise

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

Kind: instance method of RedisCache

Param	Type
key	string

Example

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

redisCache.put(key, value) ⇒ Promise

Store a single cached item (overwrites existing)

Kind: instance method of RedisCache

Param	Type
key	string
value	*

Example

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

redisCache.remove(key) ⇒ Promise

Remove a single cached item

Kind: instance method of RedisCache

Param	Type
key	string

Example

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

redisCache.quit() ⇒ Promise

Closes the client connection

Kind: instance method of RedisCache

RedisCache.PREFIX : string

Default prefix for storing keys Value: "node-openam-agent-cache:"

Kind: static property of RedisCache

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.