store
Advanced tools
Comparing version 1.1.1 to 1.2.3
| { | ||
| "name": "store", | ||
| "version": "1.2.3", | ||
| "description": "A localStorage wrapper for all browsers without using cookies or flash. Uses localStorage, globalStorage, and userData behavior under the hood", | ||
| "version": "1.1.1", | ||
| "homepage": "https://github.com/marcuswestin/store.js", | ||
| "author": "Marcus Westin <narcvs@gmail.com> (http://marcuswest.in)", | ||
| "contributors": [ | ||
| "Matt Pizzimenti <mjpizz+github@gmail.com> (http://mjpizz.com)", | ||
| "Long Ouyang (https://github.com/longouyang)", | ||
| "Paul Irish (http://paulirish.com)", | ||
| "Guillermo Rauch <rauchg@gmail.com> (https://github.com/guille)", | ||
| "whitmer (https://github.com/whitmer)", | ||
| "Steven Black <steveb@stevenblack.com> (https://github.com/StevenBlack)", | ||
| "Marcus Tucker <info@marcustucker.com> (https://github.com/MarcusJT)" | ||
| ], | ||
| "main": "dist/store.legacy.js", | ||
| "scripts": { | ||
| "test": "make test" | ||
| }, | ||
| "repository": { | ||
@@ -20,22 +13,67 @@ "type": "git", | ||
| }, | ||
| "author": "Marcus Westin <narcvs@gmail.com>", | ||
| "license": "MIT", | ||
| "bugs": { | ||
| "url": "http://github.com/marcuswestin/store.js/issues" | ||
| }, | ||
| "homepage": "https://github.com/marcuswestin/store.js#readme", | ||
| "devDependencies": { | ||
| "babel-preset-es2015": "^6.22.0", | ||
| "babelify": "^7.3.0", | ||
| "browserify": "^14.1.0", | ||
| "budo": "^7.1.0", | ||
| "eslint": "^3.12.2", | ||
| "localStorage": "^1.0.3", | ||
| "lodash": "^3.10.1", | ||
| "ngrok": "^2.2.6", | ||
| "request": "^2.67.0", | ||
| "tinytest": "^1.1.3", | ||
| "uglify-js": "^2.7.5" | ||
| }, | ||
| "eslintConfig": { | ||
| "env": { | ||
| "browser": true, | ||
| "commonjs": true, | ||
| "es6": true, | ||
| "node": true | ||
| }, | ||
| "extends": "eslint:recommended", | ||
| "parserOptions": { | ||
| "sourceType": "module" | ||
| }, | ||
| "globals": { | ||
| "test": false, | ||
| "assert": false, | ||
| "print": false | ||
| }, | ||
| "rules": { | ||
| "comma-dangle": ["error", "only-multiline"], | ||
| "no-unused-vars": [ | ||
| "error", | ||
| { | ||
| "vars": "all", | ||
| "args": "none", | ||
| "varsIgnorePattern": "^_$" | ||
| } | ||
| ], | ||
| "indent": [ | ||
| "error", | ||
| "tab" | ||
| ], | ||
| "linebreak-style": [ | ||
| "error", | ||
| "unix" | ||
| ], | ||
| "semi": [ | ||
| "error", | ||
| "never" | ||
| ] | ||
| } | ||
| }, | ||
| "engines": { | ||
| "browser": "*", | ||
| "node": "*" | ||
| }, | ||
| "licenses": [ | ||
| { | ||
| "type": "MIT", | ||
| "url": "http://github.com/marcuswestin/store.js/raw/master/LICENSE" | ||
| } | ||
| ], | ||
| "main": "store", | ||
| "directories": { | ||
| "lib": "." | ||
| }, | ||
| "files": [ | ||
| "" | ||
| ] | ||
| } | ||
| } | ||
| } |
366
README.md
@@ -1,139 +0,279 @@ | ||
| store.js | ||
| Store.js | ||
| ======== | ||
| store.js exposes a simple API for cross browser local storage | ||
| [](https://travis-ci.org/marcuswestin/store.js) | ||
| [](https://badge.fury.io/js/store) | ||
| [](https://npm-stat.com/charts.html?package=store) | ||
| // Store 'marcus' at 'username' | ||
| store.set('username', 'marcus') | ||
| // Get 'username' | ||
| store.get('username') | ||
| // Remove 'username' | ||
| store.remove('username') | ||
| // Clear all keys | ||
| store.clear() | ||
| // Store an object literal - store.js uses JSON.stringify under the hood | ||
| store.set('user', { name: 'marcus', likes: 'javascript' }) | ||
| // Get the stored object - store.js uses JSON.parse under the hood | ||
| var user = store.get('user') | ||
| alert(user.name + ' likes ' + user.likes) | ||
| 1. [Version 2.0](#user-content-version-20) | ||
| - What's new? | ||
| 2. [Basic Usage](#user-content-basic-usage) | ||
| - All you need to get started | ||
| - [API](#user-content-api) | ||
| - [Installation](#user-content-installation) | ||
| 3. [Supported Browsers](#user-content-supported-browsers) | ||
| - All of them, pretty much :) | ||
| - [List of supported browsers](#user-content-list-of-supported-browsers) | ||
| 4. [Plugins](#user-content-plugins) | ||
| - Additional common functionality | ||
| - [List of all Plugins](#user-content-list-of-all-plugins) | ||
| - [Using Plugins](#user-content-using-plugins) | ||
| - [Write your own Plugin](#user-content-write-your-own-plugin) | ||
| 5. [Builds](#user-content-builds) | ||
| - Choose which build is right for you | ||
| - [List of default Builds](#user-content-list-of-default-builds) | ||
| - [Make your own Build](#user-content-make-your-own-build) | ||
| 6. [Storages](#user-content-storages) | ||
| - Storages provide underlying persistence | ||
| - [List of all Storages](#user-content-list-of-all-storages) | ||
| - [Storages limits](#user-content-storages-limits) | ||
| - [Write your own Storage](#user-content-write-your-own-storage) | ||
| store.js depends on JSON for serialization. | ||
| IE6/7 limitation | ||
| ---------------- | ||
| Access to the userData behavior in IE6 and IE7 is restricted to "same directory" in the path of the URL, much like access to localStorage is restricted to "same domain" in the protocol and host name of the URL. In addition, just as localStorage cannot be accessed across sub domains, userData behavior cannot be accessed across sub-directories. | ||
| Version 2.0 | ||
| ----------- | ||
| Here are some examples to demonstrate the IE6 and IE7 limitations: | ||
| Store.js has been around since 2010 ([first commit](https://github.com/marcuswestin/store.js/commit/cb0198c2c02ff5f17c084276eeb4f28c79849d5e)! [HN discussion](https://news.ycombinator.com/item?id=1468802)!), and is live on tens of thousands of websites - like cnn.com! | ||
| // on http://example.com/path1/ | ||
| store.set('foo', 1) | ||
| // on http://example.com/path1/test.html the value of "foo" | ||
| // is readable because we are in the same "directory" /path1/ | ||
| store.get('foo') == 1 | ||
| store.set('bar', 2) | ||
| // on http://example.com/path2/ the values of "foo" and "bar" are not readable | ||
| // because we are not in the same "directory" - the directory is not /path2/ | ||
| store.get('foo') == null | ||
| store.get('bar') == null | ||
| For many years v1.x provided basic cross-browser persistent storage, and over time more and more people [started asking](https://github.com/marcuswestin/store.js/issues?q=is%3Aissue+is%3Aclosed) for additional functionality. | ||
| // on http://example.com/path1/subpath/ the values of "foo" and "bar" are not | ||
| // readable here either, because we are in the directory /path1/subpath/. | ||
| store.get('foo') == null | ||
| store.get('bar') == null | ||
| Store.js version 2 is a full revamp with pluggable storage (it will automatically fall back to one that works in every scenario by default), pluggable extra functionality (like [expirations](plugins/expire.js), [default values](plugins/defaults.js), common [array/object operations](plugins/operations.js), etc), and fully cross-browser automatic testing using saucelabs.com. | ||
| How does it work? | ||
| ------------------ | ||
| store.js uses localStorage when available, and falls back on globalStorage for earlier versions of Firefox and the userData behavior in IE6 and IE7. No flash to slow down your page load. No cookies to fatten your network requests. | ||
| Serialization | ||
| ------------- | ||
| localStorage, when used without store.js, calls toString on all stored values. This means that you can't conveniently store and retrieve numbers, objects or arrays: | ||
| localStorage.myage = 24 | ||
| localStorage.myage != 24 | ||
| localStorage.myage == '24' | ||
| localStorage.user = { name: 'marcus', likes: 'javascript' } | ||
| localStorage.user == "[object Object]" | ||
| localStorage.tags = ['javascript', 'localStorage', 'store.js'] | ||
| localStorage.tags.length == 32 | ||
| localStorage.tags == "javascript,localStorage,store.js" | ||
| Basic Usage | ||
| ----------- | ||
| What we want (and get with store.js) is | ||
| All you need to know to get started: | ||
| store.set('myage', 24) | ||
| store.get('myage') == 24 | ||
| store.set('user', { name: 'marcus', likes: 'javascript' }) | ||
| alert("Hi my name is " + store.get('user').name + "!") | ||
| store.set('tags', ['javascript', 'localStorage', 'store.js']) | ||
| alert("We've got " + store.get('tags').length + " tags here") | ||
| ### API | ||
| The native serialization engine of javascript is JSON. Rather than leaving it up to you to serialize and deserialize your values, store.js uses JSON.stringify() and JSON.parse() on each call to store.set() and store.get(), respectively. | ||
| store.js exposes a simple API for cross-browser local storage: | ||
| Some browsers do not have native support for JSON. For those browsers you should include [JSON.js] (non-minified copy is included in this repo). | ||
| ```js | ||
| // Store current user | ||
| store.set('user', { name:'Marcus' }) | ||
| Tests | ||
| ----- | ||
| Go to test.html in your browser. | ||
| // Get current user | ||
| store.get('user') | ||
| (Note that test.html must be served over http:// or https://. This is because localStore does not work in some browsers when using the file:// protocol) | ||
| // Remove current user | ||
| store.remove('user') | ||
| Supported browsers | ||
| // Clear all keys | ||
| store.clearAll() | ||
| // Loop over all stored values | ||
| store.each(function(value, key) { | ||
| console.log(key, '==', value) | ||
| }) | ||
| ``` | ||
| ### Installation | ||
| Using npm: | ||
| ```js | ||
| // 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](dist/)): | ||
| ```html | ||
| <!-- Example store.js usage with script tag --> | ||
| <script src="path/to/my/store.legacy.min.js"></script> | ||
| <script> | ||
| var store = require('store') | ||
| store.set('user', { name:'Marcus' }) | ||
| store.get('user').name == 'Marcus' | ||
| </script> | ||
| ``` | ||
| Supported Browsers | ||
| ------------------ | ||
| - Tested in Firefox 2.0 | ||
| - Tested in Firefox 3.0 | ||
| - Tested in Firefox 3.5 | ||
| - Tested in Firefox 3.6 | ||
| - Tested in Firefox 4.0 | ||
| - Tested in Chrome 5 | ||
| - Tested in Chrome 6 | ||
| - Tested in Chrome 7 | ||
| - Tested in Chrome 8 | ||
| - Tested in Chrome 10 | ||
| - Tested in Chrome 11 | ||
| - Tested in Safari 4 | ||
| - Tested in Safari 5 | ||
| - Tested in IE6 | ||
| - Tested in IE7 | ||
| - Tested in IE8 | ||
| - Tested in Opera 10 | ||
| - Opera 10.54 | ||
| Supported but borken (please help fix) | ||
| -------------------------------------- | ||
| - Chrome 4 | ||
| - Opera 10.10 | ||
| All of them, pretty much :) | ||
| Unsupported browsers | ||
| ------------------- | ||
| - Firefox 1.0: no means (beside cookies and flash) | ||
| - Safari 2: no means (beside cookies and flash) | ||
| - Safari 3: no synchronous api (has asynch sqlite api, but store.js is synch) | ||
| - Opera 9: don't know if there is synchronous api for storing data locally | ||
| - Firefox 1.5: don't know if there is synchronous api for storing data locally | ||
| 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](dist/store.legacy.min.js). | ||
| Forks | ||
| ---- | ||
| - Sans JSON support (simple key/values only): https://github.com/cloudhead/store.js | ||
| - jQueryfied version: https://github.com/whitmer/store.js | ||
| - Lint.js passing version (with semi-colons): https://github.com/StevenBlack/store.js | ||
| To save some kilobytes but still support all modern browsers, use `require('store/dist/store.modern')` or [store.modern.min.js](dist/store.modern.min.js) instead. | ||
| TODO | ||
| ---- | ||
| - I believe underlying APIs can throw under certain conditions. Where do we need try/catch? | ||
| - Test different versions of Opera 10.X explicitly | ||
| ### List of supported browsers | ||
| My repo: https://github.com/marcuswestin/store.js | ||
| - Tested on IE6+ | ||
| - Tested on iOS 8+ | ||
| - Tested on Android 4+ | ||
| - Tested on Firefox 4+ | ||
| - Tested on Chrome 27+ | ||
| - Tested on Safari 5+ | ||
| - Tested on Opera 11+ | ||
| - Tested on Node (with https://github.com/coolaj86/node-localStorage) | ||
| [JSON.js]: http://www.json.org/json2.js | ||
| Plugins | ||
| ------- | ||
| Plugins provide additional common functionality that some users might need: | ||
| ### List of all Plugins | ||
| - [all.js](plugins/all.js): All the plugins in one handy place. | ||
| - [defaults.js](plugins/defaults.js): Declare default values. [Example usage](plugins/defaults_test.js) | ||
| - [dump.js](plugins/dump.js): Dump all stored values. [Example usage](plugins/dump_test.js) | ||
| - [events.js](plugins/events.js): Get notified when stored values change. [Example usage](plugins/events_test.js) | ||
| - [expire.js](plugins/expire.js): Expire stored values at a given time. [Example usage](plugins/expire_test.js) | ||
| - [observe.js](plugins/observe.js): Observe stored values and their changes. [Example usage](plugins/observe_test.js) | ||
| - [operations.js](plugins/operations.js): Useful operations like push, shift & assign. [Example usage](plugins/operations_test.js) | ||
| - [update.js](plugins/update.js): Update a stored object, or create it if null. [Example usage](plugins/update_test.js) | ||
| - [v1-backcompat.js](plugins/v1-backcompat.js): Full backwards compatibility with store.js v1. [Example usage](plugins/v1-backcompat_test.js) | ||
| ### Using Plugins | ||
| With npm: | ||
| ```js | ||
| // 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](dist/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). | ||
| ```js | ||
| // 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](plugins/). Good example plugins are | ||
| [plugins/defaults](plugins/defaults.js), [plugins/expire](plugins/expire.js) and | ||
| [plugins/events](plugins/events.js). | ||
| Builds | ||
| ------ | ||
| Choose which build is right for you! | ||
| ### List of default builds | ||
| - [store.everything.min.js](dist/store.everything.min.js): All the plugins, all the storages. [Source](dist/store.everything.js) | ||
| - [store.legacy.min.js](dist/store.legacy.min.js): Full support for all tested browsers. Add plugins separately. [Source](dist/store.legacy.js) | ||
| - [store.modern.min.js](dist/store.modern.min.js): Full support for all modern browsers. Add plugins separately. [Source](dist/store.modern.js) | ||
| - [store.v1-backcompat.min.js](dist/store.v1-backcompat.min.js): Full backwards compatibility with [store.js v1](https://github.com/marcuswestin/store.js/releases/tag/v1.3.20). [Source](dist/store.v1-backcompat.js) | ||
| ### Make your own Build | ||
| If you're using npm you can create your own build: | ||
| ```js | ||
| // 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 | ||
| - [all.js](storages/all.js) All the storages in one handy place. | ||
| - [localStorage.js](storages/localStorage.js) Store values in localStorage. Great for all modern browsers. | ||
| - [sessionStorage.js](storages/sessionStorage.js) Store values in sessionStorage. | ||
| - [cookieStorage.js](storages/cookieStorage.js) Store values in cookies. Useful for Safari Private mode. | ||
| - [memoryStorage.js](storages/memoryStorage.js) Store values in memory. Great fallback to ensure store functionality at all times. | ||
| - [oldFF-globalStorage.js](storages/oldFF-globalStorage.js) Store values in globalStorage. Only useful for legacy Firefox 3+. | ||
| - [oldIE-userDataStorage.js](storages/oldIE-userDataStorage.js) Store values in userData. Only useful for legacy IE 6+. | ||
| ### 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][local-limits], [android][local-android] | | ||
| | sessionStorage | Modern browsers | Max 5mb (~2M chars) | [limits][session-limits] | | ||
| | cookieStorage | Safari Private mode | Max 4kb (~2K chars) | [limits][cookie-limits] | | ||
| | userDataStorage | IE5, IE6 & IE7 | Max 64kb (~32K chars) | [limits][userdata-limits] | | ||
| | globalStorage | Firefox 2-5 | Max 5mb (~2M chars) | [limits][global-limits] | | ||
| | memoryStorage | All browsers, fallback | Does not persist across pages! | | | ||
| [local-limits]: https://arty.name/localstorage.html | ||
| [local-android]: http://dev-test.nemikor.com/web-storage/support-test/ | ||
| [session-limits]: http://stackoverflow.com/questions/15840976/how-large-is-html5-session-storage | ||
| [cookie-limits]: http://browsercookielimits.squawky.net/ | ||
| [userdata-limits]: https://msdn.microsoft.com/en-us/library/ms533015(v=vs.85).aspx | ||
| [global-limits]: https://github.com/jeremydurham/persist-js/blob/master/README.md#4-size-limits | ||
| [more]: https://www.html5rocks.com/en/tutorials/offline/quota-research/ | ||
| ### Write your own Storage | ||
| Chances are you won't ever need another storage. But if you do... | ||
| See [storages/](storages/) for examples. Two good examples are [memoryStorage](storages/memoryStorage.js) and [localStorage](storages/localStorage.js). | ||
| Basically, you just need an object that looks like this: | ||
| ```js | ||
| // 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) | ||
| ``` |
Sorry, the diff of this file is not supported yet
New alerts
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Network access
Supply chain riskThis module accesses the network.
Found 1 instance in 1 package
Uses eval
Supply chain riskPackage uses eval() which is a dangerous function. This prevents the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.
Found 1 instance in 1 package
Dynamic require
Supply chain riskDynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.
Found 1 instance in 1 package
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
Minified code
QualityThis package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.
Found 1 instance in 1 package
Fixed alerts
Non-existent author
Supply chain riskThe package was published by an npm account that no longer exists.
Found 1 instance in 1 package
No tests
QualityPackage does not have any tests. This is a strong signal of a poorly maintained or low quality package.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by465.65%
222543
- Number of package files
- increased by800%
72
- Lines of code
- increased by493.71%
3022
- Number of lines in readme file
- increased by100%
280
- Number of high supply chain risk alerts
- decreased by-100%
0
Worsened metrics
- Dev dependency count
- increased byInfinity%
11
- Number of low quality alerts
- increased by400%
5
- Number of low supply chain risk alerts
- increased byInfinity%
12
- Number of medium supply chain risk alerts
- increased byInfinity%
6
No dependency changes