store.js README

The project's README from github.com/marcuswestin/store.js. As one markdown file: README.md.

Store.js

Cross-browser storage for all use cases, used across the web.

Circle CI npm version npm

Store.js has been around since 2010 (first commit, v1 release). It is used in production on tens of thousands of websites, such as cnn.com, dailymotion.com, & many more.

Store.js provides basic key/value storage functionality (get/set/remove/each) as well as a rich set of plug-in storages and extra functionality.

  1. Basic Usage
  2. Supported Browsers
  3. Plugins
  4. Builds
  5. Storages

Basic Usage

All you need to know to get started:

API

store.js exposes a simple API for cross-browser local storage:

// Store current user
store.set('user', { name:'Marcus' })

// Get current user
store.get('user')

// Remove current user
store.remove('user')

// Clear all keys
store.clearAll()

// Loop over all stored values
store.each(function(value, key) {
	console.log(key, '==', value)
})

Installation

Using npm:

npm i store

// Example store.js usage with npm
var store = require('store')
store.set('user', { name:'Marcus' })
store.get('user').name == 'Marcus'

Using script tag (first download one of the builds):

<!-- Example store.js usage with script tag -->
<script src="path/to/my/store.legacy.min.js"></script>
<script>
store.set('user', { name:'Marcus' })
store.get('user').name == 'Marcus'
</script>

Supported Browsers

All of them, pretty much :)

To support all browsers (including IE 6, IE 7, Firefox 4, etc.), use require('store') (alias for require('store/dist/store.legacy')) or store.legacy.min.js.

To save some kilobytes but still support all modern browsers, use require('store/dist/store.modern') or store.modern.min.js instead.

List of supported browsers

Plugins

Plugins provide additional common functionality that some users might need:

List of all Plugins

Using Plugins

With npm:

// Example plugin usage:
var expirePlugin = require('store/plugins/expire')
store.addPlugin(expirePlugin)

If you're using script tags, you can either use store.everything.min.js (which has all plugins built-in), or clone this repo to add or modify a build and run make build.

Write your own plugin

A store.js plugin is a function that returns an object that gets added to the store. If any of the plugin functions overrides existing functions, the plugin function can still call the original function using the first argument (super_fn).

// Example plugin that stores a version history of every value
var versionHistoryPlugin = function() {
	var historyStore = this.namespace('history')
	return {
		set: function(super_fn, key, value) {
			var history = historyStore.get(key) || []
			history.push(value)
			historyStore.set(key, history)
			return super_fn()
		},
		getHistory: function(key) {
			return historyStore.get(key)
		}
	}
}
store.addPlugin(versionHistoryPlugin)
store.set('foo', 'bar 1')
store.set('foo', 'bar 2')
store.getHistory('foo') == ['bar 1', 'bar 2']

Let me know if you need more info on writing plugins. For the moment I recommend taking a look at the current plugins. Good example plugins are plugins/defaults, plugins/expire and plugins/events.

Builds

Choose which build is right for you!

List of default builds

Make your own Build

If you're using npm you can create your own build:

// Example custom build usage:
var engine = require('store/src/store-engine')
var storages = [
	require('store/storages/localStorage'),
	require('store/storages/cookieStorage')
]
var plugins = [
	require('store/plugins/defaults'),
	require('store/plugins/expire')
]
var store = engine.createStore(storages, plugins)
store.set('foo', 'bar', new Date().getTime() + 3000) // Using expire plugin to expire in 3 seconds

Storages

Store.js will pick the best available storage, and automatically falls back to the first available storage that works:

List of all Storages

Storages limits

Each storage has different limits, restrictions and overflow behavior on different browser. For example, Android has has a 4.57M localStorage limit in 4.0, a 2.49M limit in 4.1, and a 4.98M limit in 4.2... Yeah.

To simplify things we provide these recommendations to ensure cross browser behavior:

Storage Targets Recommendations More info
all All browsers Store < 1 million characters (Except Safari Private mode)
all All & Private mode Store < 32 thousand characters (Including Safari Private mode)
localStorage Modern browsers Max 2mb (~1M chars) limits, android
sessionStorage Modern browsers Max 5mb (~2M chars) limits
cookieStorage Safari Private mode Max 4kb (~2K chars) limits
userDataStorage IE5, IE6 & IE7 Max 64kb (~32K chars) limits
globalStorage Firefox 2-5 Max 5mb (~2M chars) limits
memoryStorage All browsers, fallback Does not persist across pages!

Write your own Storage

Chances are you won't ever need another storage. But if you do...

See storages/ for examples. Two good examples are memoryStorage and localStorage.

Basically, you just need an object that looks like this:

// Example custom storage
var storage = {
	name: 'myStorage',
	read: function(key) { ... },
	write: function(key, value) { ... },
	each: function(fn) { ... },
	remove: function(key) { ... },
	clearAll: function() { ... }
}
var store = require('store').createStore(storage)

store.js (marcuswestin/store.js)

Searching Database…

14K ·GitHub
Store.js
What is this?Store.js is a JavaScript library for key/value storage in the browser that works across all browsers. It has been around since 2010 and is used in production on tens of thousands of websites like cnn.com and dailymotion.com.
Is this a library I pull into my frontend code, or its own app?It is a small JavaScript library. It gives you a store object with get/set/remove/each for saving data client-side — no server, no UI, just one API over browser storage.
How do I add it to a project?Install via npm, or download one of the prebuilt min.js files and load it with a script tag. After that you just call store.set and store.get.
Do I need anything else besides the script — jQuery, a build step, an account?No, nothing beyond the browser: it is a single standalone script with no dependencies, and the same API also works under Node.
How much data can I actually store?Backend limits apply: about 2MB in localStorage, 5MB in sessionStorage and just 4KB in cookies. The README recommends staying under 1M characters, or under 32K if Safari Private mode must work too.
Is this battle-tested or still experimental?Battle-tested: it has been around since 2010 and runs in production on tens of thousands of websites, including cnn.com and dailymotion.com.
Which browsers does it actually work in?Pretty much all of them: tested on IE6+, iOS 8+, Android 4+, Firefox 4+, Chrome 27+, Safari 5+, Opera 11+, plus Node. A legacy build covers IE6/IE7, while the modern build slims things down for current browsers.
Where does my data actually live, and does it survive a page reload?In the browser itself. It picks the best available backend — localStorage, sessionStorage, cookies (for Safari Private mode) or a memory fallback — and automatically falls back to the first storage that works. Only the memory fallback loses data on reload.
What do the plugins add on top of basic get and set?Extras like expire (values expire at a given time), events and observe (get notified when stored values change), defaults, operations such as push, shift and assign, update, and a dump of all stored values. The everything build bundles all of them.
Which build should I pick?store.modern.min.js for modern browsers only, store.legacy.min.js to also support IE6/IE7 and Firefox 4, store.everything.min.js if you want all plugins and storages built in, and store.v1-backcompat.min.js for full backwards compatibility with store.js v1 code.
Can I write my own plugin or storage backend?Yes. A plugin is a function that returns an object added to the store, and overridden functions can still call the original via a superfn argument; the README points to defaults, expire and events as examples. Storages are similar objects, with memoryStorage and localStorage as good templates.
What are similar projects?ultrastorage, lowdb, jquery, localForage, protobuf.js, redux-persist, Respond, markdown-it
Which topics is it in?key-value-store, localstorage, cross-browser, serialization, plugins, storage, json, browser, utility, npm, frontend, nodejs
Creator
marcuswestin
Size
0.6 MB
Stars
14K
Updated
CommitFeb 25
Age
16y
Commits · 90 Days