API/libsapojs/SAPO/Utility/Cache

Version 1 (modified by tiago.c.rodrigues, 3 years ago)

here be robots

[Elements] are optional

Class SAPO.Utility.Cache

class SAPO.Utility.Cache
Utilities for Cache
Defined in Utility/Cache/0.1/lib.js

Inclusion link: http://js.sapo.pt/SAPO/Utility/Cache/0.1/

Sample: http://js.sapo.pt/SAPO/Utility/Cache/sample/

Function Summary
private String __isDeathTime (Number deathTime)
private String _calculateDeathTime (Number lifeTime)
Object add (String id, Object|String|Array|Number item, Number lifeTime)
Add item to cache object
Object flush()
Remove all data stored
Object get()
Get cached item @param: {String} id - item ID
Object update()
Update item in cache object @param: {String} id - item ID @param: {String|Object|Array|Number} item - item value

Function Details

function __isDeathTime

private String __isDeathTime(Number deathTime)
Parameters:
deathTime
Returns:
true if life time is expired

function _calculateDeathTime

private String _calculateDeathTime(Number lifeTime)
Parameters:
lifeTime
Returns:
the death time in milliseconds

function add

Object add(String id, Object|String|Array|Number item, Number lifeTime)
Add item to cache object
Parameters:
id - item ID
item - item value
lifeTime - life time (in seconds)
Returns:
true

function flush

Object flush()
Remove all data stored
Returns:
true

function get

Object get()
Get cached item @param: {String} id - item ID
Returns:
data value

function update

Object update()
Update item in cache object @param: {String} id - item ID @param: {String|Object|Array|Number} item - item value
Returns:
true