node-localstorage

A drop-in substitute for the browser native localStorage API that runs on node.js.

node-localstorage

Copyright (c) 2012, Lawrence S. Maccherone, Jr.

A drop-in substitute for the browser native localStorage API that runs on node.js.

  • All methods in the localStorage spec interface including:
    • length
    • setItem(key, value)
    • getItem(key)
    • removeItem(key)
    • key(n)
    • clear()
  • Serializes to disk in the location specified during instantiation
  • Supports the setting of a quota (default 5MB)
  • Events
  • Associative array syntax localStorage['myKey'] = 'myValue'

Author: Larry Maccherone

unless localStorage?
  {LocalStorage} = require('../')  # require('node-localstorage') for you
  localStorage = new LocalStorage('./scratch')

localStorage.setItem('myFirstKey', 'myFirstValue')
console.log(localStorage.getItem('myFirstKey'))
# myFirstValue

localStorage._deleteLocation()  # cleans up ./scratch created during doctest
if (typeof localStorage === "undefined" || localStorage === null) {
  var LocalStorage = require('node-localstorage').LocalStorage;
  localStorage = new LocalStorage('./scratch');
}
 
localStorage.setItem('myFirstKey', 'myFirstValue');
console.log(localStorage.getItem('myFirstKey'));

npm install node-localstorage

  • 0.5.0 - 2015-02-02 - Added JSONStorage class which allows you set and get native JSON
  • 0.4.1 - 2015-02-02 - More robust publishing/tagging (like Lumenize)
  • 0.4.0 - 2015-02-02 - Uses more efficient fs.statSync to set initial size (thanks, sudheer594)
  • 0.3.6 - 2014-12-24 - Allows usage without new
  • 0.3.5 - 2014-12-23 - Fixed toString() for QuotaExceededError
  • 0.3.4 - 2013-07-07 - Moved CoffeeScript to devDependencies
  • 0.3.3 - 2013-04-05 - Added support for '/' in keys by escaping before creating file names
  • 0.3.2 - 2013-01-19 - Renamed QuotaExceededError to QUOTA_EXCEEDED_ERR to match most browsers
  • 0.3.1 - 2013-01-19 - Fixed bug where it threw plain old Error instead of new QuotaExceededError
  • 0.3.0 - 2013-01-19 - Added QuotaExceededError support
  • 0.2.0 - 2013-01-03 - Added quota support
  • 0.1.2 - 2012-11-02 - Finally got Travis CI working
  • 0.1.1 - 2012-10-29 - Update to support Travis CI
  • 0.1.0 - 2012-10-29 - Original version

Copyright (c) 2011, 2012, Lawrence S. Maccherone, Jr.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.