tiny web storage wrapper
A tiny web storage wrapper (< 1k minified). Works with localStorage, sessionStorage, objects, and functions.
Useful for interacting with a persistent namespaced object store within localStorage or sessionStorage without messing with anything else that might be there (like on *.github.io).
Similar in style to store.js but for a slightly different use case (and far less ambitious).
new TinyStore(name, optionalStore)
The constructor takes a string as a name for the object to store in localStorage.
var store = new TinyStore('memories')
Optionally, an alternative storage mechanism can be specified. localStorage, sessionStorage, objects, and functions are supported (default is localStorage).
// localStorage
var localStore = new TinyStore('local', localStorage)
// sessionStorage
var sessionStore = new TinyStore('session', sessionStorage)
// object
var obj = {}
var objectStore = new TinyStore('obj', obj)
// function
var fn = function () {}
var functionStore = new TinyStore('fn', fn)
.enabled
A boolean flag to show if the specified store is available or not.
store.enabled
// -> true (you've got localStorage/sessionStorage/an object/a function!)
// -> false (something went horribly wrong!)
.set(key, value)
Takes a key and value and saves the pair to storage. The key should be a string, and the value can be any standard JSON value (string, number, array, object).
store.set('saturday', 'karaoke')
// -> "karaoke"
store.set('sunday', ['hangover', 'NaptimePDX'])
// -> ["hangover", "NaptimePDX"]
store.set('monday', { 'work': ['meetings', 'coding'] })
// -> { "work": ["meetings", "coding"] }
.get(key)
Returns a key's value if it exists.
store.get('saturday')
// -> "karaoke"
store.get('friday')
// -> undefined
.session
A plain old object that gets parsed out of storage and stringified back in.
store.session
// -> { "saturday": "karaoke", "sunday": ["hangover", "NaptimePDX"], "monday": { "work": ["meetings", "coding"] } }
// you can manipulate the session object directly if that's your jam
// keep in mind you'll have to manually `.save()` afterwards when you do this
store.session.whatever = { 'doge': 'sweater vests' }
.save()
Persists the session object (.set() does this automatically).
store.save()
// -> { "saturday": "karaoke", "sunday": ["hangover", "NaptimePDX"], "monday": { "work": ["meetings", "coding"] }, "whatever": { "doge": "sweater vests" } }
.remove(key)
Removes a given key from the .session object and saves the change to storage. Returns the key's value in case you want to do something fancy.
store.remove('whatever')
// -> { 'doge': 'sweater vests' }
.clear()
Removes the item from storage, if enabled, and resets the .session object.
store.clear()
// -> {}
npm installnpm testnpm run minifyISC