This package has been deprecated

Author message:

Moved to @forgerock/openam-agent-cache-simple

openam-agent-cache-simple

Simple in-memory cache for the OpenAM Policy Agent for NodeJS

Installation: npm install openam-agent-cache-simple

API Docs

SimpleCache ⇐ Cache

Kind: global class
Extends: Cache

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

new SimpleCache([options])

Cache implementation that stores entries in an object in memory (not efficient for large caches)

Param	Type	Default	Description
[options]	object		Options
[options.expireAfterSeconds]	number	300	Expiration time in seconds (if undefined, entries won't expire)
[options.logger]	winston~Logger		Logger

Example

var agent = new PolicyAgent({
  cache: new SimpleCache({expireAfterSeconds: 600}) // cached entries expire after 10 minutes
  ...
})

simpleCache.get(key) ⇒ Promise

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

Kind: instance method of SimpleCache

Param	Type
key	string

simpleCache.put(key, value)

Store a single cached item (overwrites existing)

Kind: instance method of SimpleCache

Param	Type
key	string
value	*

simpleCache.remove(key) ⇒ Promise

Remove a single cached item

Kind: instance method of SimpleCache

Param	Type
key	string

simpleCache.quit() ⇒ Promise

If this were a database, it would close the connection, but since it's not, it doesn't

Kind: instance method of SimpleCache