JavaScript caching framework for client side caching in the browser using localStorage - gracefully degrades when the browser doesn't support localStorage.
JavaScript CSS HTML Makefile
Latest commit 8378751 Feb 14, 2016 @d0ugal d0ugal Merge pull request #21 from riophae/fix-cleanup
Fix cleanup
Failed to load latest commit information.
docs New version added Jun 30, 2015
gh-pages Hack to fix font rendering during animation in Chrome on Windows. Dec 6, 2013
tests fix test for expiring Feb 14, 2016
AUTHORS Bit of a general tidy up - moved the version into Apr 9, 2012
CNAME Removed the www. as it looks like DNS changes have finally propagated. Apr 12, 2012
Makefile locache version 0.3.1 build Jun 20, 2012
README.rst Update README.rst Oct 29, 2013
bower.json only ignore gh-pages files Jan 29, 2014
index.html Site updated Jun 30, 2015
locache.js fix cleanup Feb 14, 2016



JavaScript framework for client side caching in the browser using DOM Storage with expiring values. With a memcache inspired API usage is very simple. Locache has no dependencies and is very small.

locache gracefully degrades when the browser doesn't support localStorage. Usually this will be IE6 or IE7, you wont get any errors, but caching attempts will be silently dropped and lookups will always appear to be a cache miss.

When and why?

Locache.js isn't a replacement for cache headers, and won't replace real server side caching. However, locache can be used to help speed up pages By caching results from APIs that you can't control or by caching complex structures created in JavaScript to avoid recreating. This works well with Models in backbone or rendered templates for example.

Setting, getting and removing values

Values can be stored one at a time as shown below, these values will never expire and will only be removed when you (or the browser) removes them.

locache.set("my_key", "my_value")

// my_value


When you store an object, that's what you'll get back. For example, a number:

locache.set("counter", 1)
typeof locache.get("counter")
// number

Storing complex objects isn't a problem too. Just make sure they are JSON serializable.

locache.set('user', {
    'name': "Dougal Matthews",
    'alias': d0ugal

var result = locache.get('user')

//    'name': "Dougal Matthews",
//    'alias': d0ugal

You can also perform batch operations.

    'name': 'locache',
    'language': 'JavaScript'

locache.getMany(['name', 'language'])
// ['locache', 'JavaScript']

locache.removeMany(['name', 'language'])

Setting values that expire

seconds = 5;
locache.set("key", "value", seconds);

// After 5 seconds this will return null.

Incrementing and decrementing? Sure.

// 1
// 2
// 1
// 0
// -1

Flushing the cache

Use the following to clear only the locache values stored in localStorage.


Performing cleanup

Since localStorage doesn't support expiring values, they will still be left around. This may or may not be a problem for you. If you want to make sure they are cleaned up, use the following method on page load, or with a setTimeout loop.