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

mentioned purpose, added better usage example, added more formatting

This commit is contained in:
AJ ONeal 2011-07-22 14:17:18 -07:00
parent d3538718b9
commit 1e2bf28341
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -3,9 +3,23 @@ localStorage
An inefficient, but as W3C-compliant as possible using only pure JavaScript, `localStorage` implementation. An inefficient, but as W3C-compliant as possible using only pure JavaScript, `localStorage` implementation.
var localStorage = require('localStorage'); Purpose
----
This is meant for the purpose of being able to run unit-tests and such for browser-y modules in node.
Usage
----
var localStorage = require('localStorage')
, myValue = { foo: 'bar', baz: 'quux' }
;
localStorage.setItem('myKey', JSON.stringify(myValue));
myValue = localStorage.getItem('myKey');
API API
---
* getItem(key) * getItem(key)
* setItem(key, value) * setItem(key, value)
@ -15,6 +29,7 @@ API
* length * length
Tests Tests
---
0 === localStorage.length; 0 === localStorage.length;
null === localStorage.getItem('doesn't exist'); null === localStorage.getItem('doesn't exist');
@ -36,5 +51,6 @@ Tests
TODO / Bugs TODO / Bugs
--- ---
Does not persist. * Does not persist.
Doesn't not emit `Storage` events * could use `fs.readFileSync` at load and an occasional `fs.writeFile` to write-out localStorage.json
* Doesn't not emit `Storage` events