README.md

Boomerang Cache

boomerangCache is a client side caching library based on localStorage.

How to install?

Npm:

npm install boomerang-cache

Bower:

bower install boomerang-cache

Docs

https://giraysam.github.io/boomerang-cache

API Reference

• create
• check
• set
• get
• getAll
• length
• remove
• clear

---

BoomerangCache.create

Creates a new bucket.

Arguments

1. bucket (String)
2. options (Object)
   • storage: (local | session)
   • encrypt: (true | false)

var boomerang = BoomerangCache.create('bucket1', {storage: 'local', encrypt: true});

BoomerangCache.set

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

Arguments

1. key (String)
2. value (String, Number, Object, Array)
3. seconds (Number) - optional

These values will never expire and will only be removed when you (or the browser) removes them.

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);

BoomerangCache.get

Returns the saved value for given key. If value is null or undefined it returns a default value.

Arguments

1. key (String)
2. defaultValue (String, Number, Object, Array)

boomerang.get('key', 'Hello World'); // If value is null returns Hello World.

BoomerangCache.getAll

Returns all saved values.

boomerang.getAll();
// {key1: 'value1'}, {key2: 'value2'}

BoomerangCache.length

Returns all values count.

boomerang.length();
// returns 2

BoomerangCache.remove

Remove a key from storage

Arguments

1. key (String)

boomerang.remove('key');

BoomerangCache.clear

Empties storage

boomerang.clear();