Cache 

Kind: global interface


cache.clear() 

Clears the cache by deleting all entries.

Kind: instance method of Cache


cache.has(key) ⇒ boolean 

Tests whether the cache contains a fresh entry for the specified key. A cache entry is fresh if the has not expired its TTL (time to live).

The method always returns false if the cache is currently disabled.

Kind: instance method of Cache
Returns: boolean - true if the cache is enabled, the entry exists and has not expired yet.

Param Type Description
key string The identifier of the cache entry.

cache.get(key) ⇒ \* 

Returns the value of the entry identified by the specified key.

The method returns null if the specified entry does not exist, has already expired, or the cache is currently disabled.

Kind: instance method of Cache
Returns: \* - The value of the specified cache entry, or null if the entry is not available.

Param Type Description
key string The identifier of the cache entry.

cache.set(key, value, [ttl]) 

Sets the cache entry identified by the specified key to the provided value. The entry is created if it does not exist yet.

The method has no effect if the cache is currently disabled.

Kind: instance method of Cache

Param Type Description
key string The identifier of the cache entry.
value \* The cache entry value.
[ttl] number Cache entry time to live in milliseconds. The entry will expire after the specified amount of milliseconds. Use null or omit the parameter to use the default TTL of this cache.

cache.delete(key) 

Deletes the specified cache entry. The method has no effect if the entry does not exist.

Kind: instance method of Cache

Param Type Description
key string The identifier of the cache entry.

cache.disable() 

Disables the cache, preventing the retrieval of any cached entries and reporting all cache entries as non-existing. Disabling the cache does not however prevent modifying the existing or creating new cache entries.

Disabling the cache also clears all of its current entries.

The method has no effect if the cache is already disabled.

Kind: instance method of Cache


cache.enable() 

Enables the cache, allowing the retrieval of cache entries.

The method has no effect if the cache is already enabled.

Kind: instance method of Cache


cache.serialize() ⇒ string 

Exports the state of this cache to an HTML-safe JSON string. The data obtained by parsing the result of this method are compatible with the deserialize method.

Kind: instance method of Cache
Returns: string - A JSON string containing an object representing of the current state of this cache.


cache.deserialize(serializedData) 

Loads the provided serialized cache data into this cache. Entries present in this cache but not specified in the provided data will remain in this cache intact.

Kind: instance method of Cache

Param Type Description
serializedData Object.<string, {value: \*, ttl: number}> An object representing the state of the cache to load, obtained by parsing the JSON string returned by the serialize method.