coolaj86/json-storage.js
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
AJ ONeal 2014-02-03 15:13:19 -06:00
parent c4efbba4da
commit 780b7583a1
1 changed files with 2 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -45,7 +45,7 @@ API
* `JsonStorage.create(DOMStorage, namespace, opts)` * `JsonStorage.create(DOMStorage, namespace, opts)`
* `DOMStorage` should be globalStorage, sessionStorage, or localStorage. Defaults to window.localStorage if set to `null`. * `DOMStorage` should be globalStorage, sessionStorage, or localStorage. Defaults to window.localStorage if set to `null`.
* `namespace` is optional string which allows multiple non-conflicting storage containers. Use `null` if you want opts but not a namespace * `namespace` is optional string which allows multiple non-conflicting storage containers. For example you could pass two widgets different storage containers and not worry about naming conflicts: `Gizmos.create(JsonStorage.create(null, 'my-gizmos')); Gadgets.create(JsonStorage.create(null, 'my-gadgets'))`
* `opts` * `opts`
* `stringify` set to `false` in `node` to avoid double stringifying * `stringify` set to `false` in `node` to avoid double stringifying
* `store.get(key)` * `store.get(key)`
@ -57,14 +57,7 @@ API
* `store.toJSON()` * `store.toJSON()`
* `JSON.stringify(store)` * `JSON.stringify(store)`
Upgrading from localStorage and 1.0.x to 1.1.x **NOTE**: You cannot omit optional parameters. Use `null` if you want accepts the defaults for some things and provide a values for others. For example: `JsonStorage.create(null, null, { stringify: false })`
===
1.1.x automatically attempts to upgrade your DOMStorage to use namespaces in backwards-compatible way.
However, you can prevent this behaviour:
localStorage.getItem('_json-storage-namespaced_', true);
null vs undefined in JSON null vs undefined in JSON
=== ===