simpleStorage
Cross-browser key-value store database to store data locally in the browser.
simpleStorage is a fork of jStorage that only includes the minimal set of features. Basically it is a wrapper for native JSON + localStorage with some TTL magic mixed in.
The module has no dependencies, you can use it as a standalone script (introduces simpleStorage global) or as an AMD module. All modern browsers (including mobile) are supported, older browsers (IE7, Firefox 3) are not.
simpleStorage is very small - about 1kB in size when minimized and gzipped.
Install
Download simpleStorage.js or install with bower:
bower install simpleStorage
and include the following script in your web application: bower_components/simpleStorage/simpleStorage.js
Support simpleStorage development
If you want to support with Bitcoins, then my wallet address is 15Z8ADxhssKUiwP3jbbqJwA21744KMCfTM
Usage
simpleStorage API is a subset of jStorage with slight modifications, so for most cases it should work out of the box if you are converting from jStorage. Main difference is between return values - if an action failed because of an error (storage full, storage not available, invalid data used etc.), you get the error object as the return value. jStorage never indicated anything if an error occurred.
set(key, value[, options])
Store or update a value in local storage.
simpleStorage.set(key, value[, options])Where
- key - the key for the value
- value - value to be stored (can be any JSONeable value)
- options - optional options object. Currently only available option is
options.TTLwhich can be used to set the TTL value to the keysimpleStorage.set(key, value, {TTL: 1000})
Return values
- true - value was stored
- false - value was not stored
- Error object - value was not stored because of an error
get(key)
Retrieve a value from local storage.
value = simpleStorage.get(key)Where
- key - the key to be retrieved
Method returns the value for a key or undefined if the key was not found.
deleteKey(key)
Removes a value from local storage.
simpleStorage.deleteKey(key)Return values
- true - value was deleted
- false - value was not found
- Error object - value was not deleted because of an error
setTTL(key, ttl)
Set a millisecond timeout. When the timeout is reached, the key is removed automatically from local storage.
simpleStorage.setTTL(key, ttl)Where
- key - the key to be updated
- ttl - timeout in milliseconds. If the value is 0, timeout is cleared from the key
Return values
- true - ttl was set
- false - value was not found
- Error object - ttl was not set because of an error
getTTL(key)
Retrieve remaining milliseconds for a key with TTL
ttl = simpleStorage.getTTL(key)Where
- key - the key to be checked
Return values
- finite number - remaining milliseconds
- Infinity - TTL is not set for the selected key
- false - selected key does not exist or is expired
flush()
Clear all values
simpleStorage.flush()Return values
- true - storage was flushed
- Error object - storage was not flushed because of an error
index()
Retrieve all used keys as an array
list = simpleStorage.index()Returns an array of keys.
storageSize()
Get used storage in symbol count
simpleStorage.storageSize()canUse()
Check if local storage can be used
simpleStorage.canUse()Returns true if storage is available
Demo
See demo here.