Global

Methods

check()

Source:
Check browser support.
Example
boomerang.check();
// returns true or false
Returns:
true|false

clear()

Source:
Empties storage.
Example
boomerang.clear();

create(store, options) → {BoomerangCache}

Source:
This method to create a BoomerangCache instance.
Example
var boomerang = BoomerangCache.create('bucket1', {storage: 'local', encrypt: true});
Parameters:
Name Type Description
store string store name to create a multiple bucket
options object storage: (local | session) - encrypt: (true | false)
Returns:
Type
BoomerangCache

get(key, defaultValue) → {string|number|object|array}

Source:
Returns the saved value for given key. If value is null or undefined it returns a default value.
Example
boomerang.get('key', 'Hello World');
// If value is null returns Hello World.
Parameters:
Name Type Description
key string required
defaultValue string | number | object | array optional
Returns:
Type
string | number | object | array

getAll() → {object}

Source:
Returns all saved values.
Example
boomerang.getAll();
// {key1: 'value1'}, {key2: 'value2'}
Returns:
Type
object

length()

Source:
Returns all values count.
Example
boomerang.length();
// returns 2
Returns:
Number

remove(key) → {object}

Source:
Remove a key from storage.
Example
boomerang.remove('key');
Parameters:
Name Type Description
key string required
Returns:
Type
object

set(key, value, seconds) → {string|number|object|array}

Source:
Set a key to a particular value or a hash object (Object or Array) under a hash key.
Examples

Set values unlimited.

boomerang.set('stringData', 'Hello World');
boomerang.set('numberData', 12345);
boomerang.set('objectData', {value: 'Hello World'});
boomerang.set('arrayData', [{value: 'Hello World'}, {value: 'Hello Boomerang'}]);

Set values with expire.

// After 3 seconds this will return null.
var seconds = 3;
boomerang.set('key', 'Hello World', seconds);
Parameters:
Name Type Description
key string required
value string | number | object | array required
seconds number optional
Returns:
Type
string | number | object | array