1. module node-localstorage
   1. function node-localstorage.JSONStorage ()
   2. function node-localstorage.LocalStorage (_location, quota)
   3. function node-localstorage.QUOTA_EXCEEDED_ERR (message)
   4. object node-localstorage.JSONStorage.prototype
   5. object node-localstorage.LocalStorage.prototype
   6. object node-localstorage.QUOTA_EXCEEDED_ERR.prototype
2. module node-localstorage.JSONStorage
   1. boolean node-localstorage.JSONStorage.usingDomains
   2. function node-localstorage.JSONStorage ()
   3. function node-localstorage.JSONStorage.EventEmitter ()
   4. function node-localstorage.JSONStorage.init ()
   5. function node-localstorage.JSONStorage.listenerCount (emitter, type)
   6. number node-localstorage.JSONStorage.defaultMaxListeners
   7. object node-localstorage.JSONStorage.__super__
3. module node-localstorage.JSONStorage.prototype
   1. function node-localstorage.JSONStorage.prototype.constructor ()
   2. function node-localstorage.JSONStorage.prototype.getItem (key)
   3. function node-localstorage.JSONStorage.prototype.setItem (key, value)
4. module node-localstorage.LocalStorage
   1. boolean node-localstorage.LocalStorage.usingDomains
   2. function node-localstorage.LocalStorage (_location, quota)
   3. function node-localstorage.LocalStorage.EventEmitter ()
   4. function node-localstorage.LocalStorage.init ()
   5. function node-localstorage.LocalStorage.listenerCount (emitter, type)
   6. number node-localstorage.LocalStorage.defaultMaxListeners
   7. object node-localstorage.LocalStorage.__super__
5. module node-localstorage.LocalStorage.prototype
   1. function node-localstorage.LocalStorage.prototype._deleteLocation ()
   2. function node-localstorage.LocalStorage.prototype._getBytesInUse ()
   3. function node-localstorage.LocalStorage.prototype._getStat (key)
   4. function node-localstorage.LocalStorage.prototype._init ()
   5. function node-localstorage.LocalStorage.prototype.clear ()
   6. function node-localstorage.LocalStorage.prototype.constructor (_location, quota)
   7. function node-localstorage.LocalStorage.prototype.getItem (key)
   8. function node-localstorage.LocalStorage.prototype.key (n)
   9. function node-localstorage.LocalStorage.prototype.removeItem (key)
   10. function node-localstorage.LocalStorage.prototype.setItem (key, value)
6. module node-localstorage.QUOTA_EXCEEDED_ERR
   1. function node-localstorage.QUOTA_EXCEEDED_ERR (message)
   2. function node-localstorage.QUOTA_EXCEEDED_ERR.captureStackTrace ()
   3. number node-localstorage.QUOTA_EXCEEDED_ERR.stackTraceLimit
   4. object node-localstorage.QUOTA_EXCEEDED_ERR.__super__
7. module node-localstorage.QUOTA_EXCEEDED_ERR.prototype
   1. function node-localstorage.QUOTA_EXCEEDED_ERR.prototype.constructor (message)
   2. function node-localstorage.QUOTA_EXCEEDED_ERR.prototype.toString ()

module node-localstorage

function node-localstorage.JSONStorage ()

• description and source-code

  function JSONStorage() {
    return JSONStorage.__super__.constructor.apply(this, arguments);
  }

• example usage

  n/a

function node-localstorage.LocalStorage (_location, quota)

• description and source-code

  function LocalStorage(_location, quota) {
    this._location = _location;
    this.quota = quota != null ? quota : 5 * 1024 * 1024;
    if (!(this instanceof LocalStorage)) {
      return new LocalStorage(this._location, this.quota);
    }
    this._location = path.resolve(this._location);
    if (instanceMap[this._location] != null) {
      return instanceMap[this._location];
    }
    this.length = 0;
    this._bytesInUse = 0;
    this._keys = [];
    this._metaKeyMap = createMap();
    this._eventUrl = "pid:" + process.pid;
    this._init();
    this._QUOTA_EXCEEDED_ERR = QUOTA_EXCEEDED_ERR;
    instanceMap[this._location] = this;
    return instanceMap[this._location];
  }

• example usage

  n/a

function node-localstorage.QUOTA_EXCEEDED_ERR (message)

• description and source-code

  function QUOTA_EXCEEDED_ERR(message) {
    this.message = message != null ? message : 'Unknown error.';
    if (Error.captureStackTrace != null) {
      Error.captureStackTrace(this, this.constructor);
    }
    this.name = this.constructor.name;
  }

• example usage

  n/a

module node-localstorage.JSONStorage

function node-localstorage.JSONStorage ()

• description and source-code

  function JSONStorage() {
    return JSONStorage.__super__.constructor.apply(this, arguments);
  }

• example usage

  n/a

function node-localstorage.JSONStorage.EventEmitter ()

• description and source-code

  function EventEmitter() {
    EventEmitter.init.call(this);
  }

• example usage

  n/a

function node-localstorage.JSONStorage.init ()

• description and source-code

  init = function () {
    this.domain = null;
    if (EventEmitter.usingDomains) {
      // if there is an active domain, then attach to it.
      domain = domain || require('domain');
      if (domain.active && !(this instanceof domain.Domain)) {
        this.domain = domain.active;
      }
    }
  
    if (!this._events || this._events === Object.getPrototypeOf(this)._events) {
      this._events = new EventHandlers();
      this._eventsCount = 0;
    }
  
    this._maxListeners = this._maxListeners || undefined;
  }

• example usage

  n/a

function node-localstorage.JSONStorage.listenerCount (emitter, type)

• description and source-code

  listenerCount = function (emitter, type) {
    if (typeof emitter.listenerCount === 'function') {
      return emitter.listenerCount(type);
    } else {
      return listenerCount.call(emitter, type);
    }
  }

• example usage

  ...
    } catch (error) {
      fs.mkdirSync(this._location);
    }
  };
  
  LocalStorage.prototype.setItem = function(key, value) {
    var encodedKey, evnt, existsBeforeSet, filename, hasListeners, metaKey, oldLength, oldValue, valueString, valueStringLength;
    hasListeners = events.EventEmitter.listenerCount(this, 'storage');
    oldValue = null;
    if (hasListeners) {
      oldValue = this.getItem(key);
    }
    key = _escapeKey(key);
    encodedKey = encodeURIComponent(key);
    filename = path.join(this._location, encodedKey);
  ...

module node-localstorage.JSONStorage.prototype

function node-localstorage.JSONStorage.prototype.constructor ()

• description and source-code

  function JSONStorage() {
    return JSONStorage.__super__.constructor.apply(this, arguments);
  }

• example usage

  n/a

function node-localstorage.JSONStorage.prototype.getItem (key)

• description and source-code

  getItem = function (key) {
    return JSON.parse(JSONStorage.__super__.getItem.call(this, key));
  }

• example usage

  ...
  ### CoffeeScript ###
  
      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
  
  ### JavaScript ###
  
  ```JavaScript
  ...

function node-localstorage.JSONStorage.prototype.setItem (key, value)

• description and source-code

  setItem = function (key, value) {
    var newValue;
    newValue = JSON.stringify(value);
    return JSONStorage.__super__.setItem.call(this, key, newValue);
  }

• example usage

  ...
  
  ### CoffeeScript ###
  
      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
  
  ### JavaScript ###
  ...

module node-localstorage.LocalStorage

function node-localstorage.LocalStorage (_location, quota)

• description and source-code

  function LocalStorage(_location, quota) {
    this._location = _location;
    this.quota = quota != null ? quota : 5 * 1024 * 1024;
    if (!(this instanceof LocalStorage)) {
      return new LocalStorage(this._location, this.quota);
    }
    this._location = path.resolve(this._location);
    if (instanceMap[this._location] != null) {
      return instanceMap[this._location];
    }
    this.length = 0;
    this._bytesInUse = 0;
    this._keys = [];
    this._metaKeyMap = createMap();
    this._eventUrl = "pid:" + process.pid;
    this._init();
    this._QUOTA_EXCEEDED_ERR = QUOTA_EXCEEDED_ERR;
    instanceMap[this._location] = this;
    return instanceMap[this._location];
  }

• example usage

  n/a

function node-localstorage.LocalStorage.EventEmitter ()

• description and source-code

  function EventEmitter() {
    EventEmitter.init.call(this);
  }

• example usage

  n/a

function node-localstorage.LocalStorage.init ()

• description and source-code

  init = function () {
    this.domain = null;
    if (EventEmitter.usingDomains) {
      // if there is an active domain, then attach to it.
      domain = domain || require('domain');
      if (domain.active && !(this instanceof domain.Domain)) {
        this.domain = domain.active;
      }
    }
  
    if (!this._events || this._events === Object.getPrototypeOf(this)._events) {
      this._events = new EventHandlers();
      this._eventsCount = 0;
    }
  
    this._maxListeners = this._maxListeners || undefined;
  }

• example usage

  n/a

function node-localstorage.LocalStorage.listenerCount (emitter, type)

• description and source-code

  listenerCount = function (emitter, type) {
    if (typeof emitter.listenerCount === 'function') {
      return emitter.listenerCount(type);
    } else {
      return listenerCount.call(emitter, type);
    }
  }

• example usage

  ...
    } catch (error) {
      fs.mkdirSync(this._location);
    }
  };
  
  LocalStorage.prototype.setItem = function(key, value) {
    var encodedKey, evnt, existsBeforeSet, filename, hasListeners, metaKey, oldLength, oldValue, valueString, valueStringLength;
    hasListeners = events.EventEmitter.listenerCount(this, 'storage');
    oldValue = null;
    if (hasListeners) {
      oldValue = this.getItem(key);
    }
    key = _escapeKey(key);
    encodedKey = encodeURIComponent(key);
    filename = path.join(this._location, encodedKey);
  ...

module node-localstorage.LocalStorage.prototype

function node-localstorage.LocalStorage.prototype._deleteLocation ()

• description and source-code

  _deleteLocation = function () {
    delete instanceMap[this._location];
    _rm(this._location);
    this._metaKeyMap = {};
    this._keys = [];
    this.length = 0;
    return this._bytesInUse = 0;
  }

• example usage

  ...
      {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
  
  ### JavaScript ###
  
  ```JavaScript
  if (typeof localStorage === "undefined" || localStorage === null) {
  var LocalStorage = require('node-localstorage').LocalStorage;
  localStorage = new LocalStorage('./scratch');
  ...

function node-localstorage.LocalStorage.prototype._getBytesInUse ()

• description and source-code

  _getBytesInUse = function () {
    return this._bytesInUse;
  }

• example usage

  n/a

function node-localstorage.LocalStorage.prototype._getStat (key)

• description and source-code

  _getStat = function (key) {
    var error, filename;
    key = _escapeKey(key);
    filename = path.join(this._location, encodeURIComponent(key));
    try {
      return fs.statSync(filename);
    } catch (error) {
      return null;
    }
  }

• example usage

  ...
    _keys = fs.readdirSync(this._location);
    for (index = i = 0, len = _keys.length; i < len; index = ++i) {
      k = _keys[index];
      _decodedKey = decodeURIComponent(k);
      this._keys.push(_decodedKey);
      _MetaKey = new MetaKey(k, index);
      this._metaKeyMap[_decodedKey] = _MetaKey;
      stat = this._getStat(k);
      if ((stat != null ? stat.size : void 0) != null) {
        _MetaKey.size = stat.size;
        this._bytesInUse += stat.size;
      }
    }
    this.length = _keys.length;
  } catch (error) {
  ...

function node-localstorage.LocalStorage.prototype._init ()

• description and source-code

  _init = function () {
    var _MetaKey, _decodedKey, _keys, error, i, index, k, len, stat;
    try {
      stat = fs.statSync(this._location);
      if ((stat != null) && !stat.isDirectory()) {
        throw new Error("A file exists at the location '" + this._location + "' when trying to create/open localStorage");
      }
      this._bytesInUse = 0;
      this.length = 0;
      _keys = fs.readdirSync(this._location);
      for (index = i = 0, len = _keys.length; i < len; index = ++i) {
        k = _keys[index];
        _decodedKey = decodeURIComponent(k);
        this._keys.push(_decodedKey);
        _MetaKey = new MetaKey(k, index);
        this._metaKeyMap[_decodedKey] = _MetaKey;
        stat = this._getStat(k);
        if ((stat != null ? stat.size : void 0) != null) {
          _MetaKey.size = stat.size;
          this._bytesInUse += stat.size;
        }
      }
      this.length = _keys.length;
    } catch (error) {
      fs.mkdirSync(this._location);
    }
  }

• example usage

  ...
      return instanceMap[this._location];
    }
    this.length = 0;
    this._bytesInUse = 0;
    this._keys = [];
    this._metaKeyMap = createMap();
    this._eventUrl = "pid:" + process.pid;
    this._init();
    this._QUOTA_EXCEEDED_ERR = QUOTA_EXCEEDED_ERR;
    instanceMap[this._location] = this;
    return instanceMap[this._location];
  }
  
  LocalStorage.prototype._init = function() {
    var _MetaKey, _decodedKey, _keys, error, i, index, k, len, stat;
  ...

function node-localstorage.LocalStorage.prototype.clear ()

• description and source-code

  clear = function () {
    var evnt;
    _emptyDirectory(this._location);
    this._metaKeyMap = createMap();
    this._keys = [];
    this.length = 0;
    this._bytesInUse = 0;
    if (events.EventEmitter.listenerCount(this, 'storage')) {
      evnt = new StorageEvent(null, null, null, this._eventUrl);
      return this.emit('storage', evnt);
    }
  }

• example usage

  n/a

function node-localstorage.LocalStorage.prototype.constructor (_location, quota)

• description and source-code

  function LocalStorage(_location, quota) {
    this._location = _location;
    this.quota = quota != null ? quota : 5 * 1024 * 1024;
    if (!(this instanceof LocalStorage)) {
      return new LocalStorage(this._location, this.quota);
    }
    this._location = path.resolve(this._location);
    if (instanceMap[this._location] != null) {
      return instanceMap[this._location];
    }
    this.length = 0;
    this._bytesInUse = 0;
    this._keys = [];
    this._metaKeyMap = createMap();
    this._eventUrl = "pid:" + process.pid;
    this._init();
    this._QUOTA_EXCEEDED_ERR = QUOTA_EXCEEDED_ERR;
    instanceMap[this._location] = this;
    return instanceMap[this._location];
  }

• example usage

  n/a

function node-localstorage.LocalStorage.prototype.getItem (key)

• description and source-code

  getItem = function (key) {
    var filename, metaKey;
    key = _escapeKey(key);
    metaKey = this._metaKeyMap[key];
    if (!!metaKey) {
      filename = path.join(this._location, metaKey.key);
      return fs.readFileSync(filename, 'utf8');
    } else {
      return null;
    }
  }

• example usage

  ...
  ### CoffeeScript ###
  
      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
  
  ### JavaScript ###
  
  ```JavaScript
  ...

function node-localstorage.LocalStorage.prototype.key (n)

• description and source-code

  key = function (n) {
    return this._keys[n];
  }

• example usage

  n/a

function node-localstorage.LocalStorage.prototype.removeItem (key)

• description and source-code

  removeItem = function (key) {
    var evnt, filename, hasListeners, k, meta, metaKey, oldValue, ref, v;
    key = _escapeKey(key);
    metaKey = this._metaKeyMap[key];
    if (!!metaKey) {
      hasListeners = events.EventEmitter.listenerCount(this, 'storage');
      oldValue = null;
      if (hasListeners) {
        oldValue = this.getItem(key);
      }
      delete this._metaKeyMap[key];
      this.length -= 1;
      this._bytesInUse -= metaKey.size;
      filename = path.join(this._location, metaKey.key);
      this._keys.splice(metaKey.index, 1);
      ref = this._metaKeyMap;
      for (k in ref) {
        v = ref[k];
        meta = this._metaKeyMap[k];
        if (meta.index > metaKey.index) {
          meta.index -= 1;
        }
      }
      _rm(filename);
      if (hasListeners) {
        evnt = new StorageEvent(key, oldValue, null, this._eventUrl);
        return this.emit('storage', evnt);
      }
    }
  }

• example usage

  n/a

function node-localstorage.LocalStorage.prototype.setItem (key, value)

• description and source-code

  setItem = function (key, value) {
    var encodedKey, evnt, existsBeforeSet, filename, hasListeners, metaKey, oldLength, oldValue, valueString, valueStringLength;
    hasListeners = events.EventEmitter.listenerCount(this, 'storage');
    oldValue = null;
    if (hasListeners) {
      oldValue = this.getItem(key);
    }
    key = _escapeKey(key);
    encodedKey = encodeURIComponent(key);
    filename = path.join(this._location, encodedKey);
    valueString = value.toString();
    valueStringLength = valueString.length;
    metaKey = this._metaKeyMap[key];
    existsBeforeSet = !!metaKey;
    if (existsBeforeSet) {
      oldLength = metaKey.size;
    } else {
      oldLength = 0;
    }
    if (this._bytesInUse - oldLength + valueStringLength > this.quota) {
      throw new QUOTA_EXCEEDED_ERR();
    }
    writeSync(filename, valueString, 'utf8');
    if (!existsBeforeSet) {
      metaKey = new MetaKey(encodedKey, (this._keys.push(key)) - 1);
      metaKey.size = valueStringLength;
      this._metaKeyMap[key] = metaKey;
      this.length += 1;
      this._bytesInUse += valueStringLength;
    }
    if (hasListeners) {
      evnt = new StorageEvent(key, oldValue, value, this._eventUrl);
      return this.emit('storage', evnt);
    }
  }

• example usage

  ...
  
  ### CoffeeScript ###
  
      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
  
  ### JavaScript ###
  ...

module node-localstorage.QUOTA_EXCEEDED_ERR

function node-localstorage.QUOTA_EXCEEDED_ERR (message)

• description and source-code

  function QUOTA_EXCEEDED_ERR(message) {
    this.message = message != null ? message : 'Unknown error.';
    if (Error.captureStackTrace != null) {
      Error.captureStackTrace(this, this.constructor);
    }
    this.name = this.constructor.name;
  }

• example usage

  n/a

function node-localstorage.QUOTA_EXCEEDED_ERR.captureStackTrace ()

• description and source-code

  function captureStackTrace() { [native code] }

• example usage

  ...
  
    QUOTA_EXCEEDED_ERR = (function(superClass) {
  extend(QUOTA_EXCEEDED_ERR, superClass);
  
  function QUOTA_EXCEEDED_ERR(message) {
    this.message = message != null ? message : 'Unknown error.';
    if (Error.captureStackTrace != null) {
      Error.captureStackTrace(this, this.constructor);
    }
    this.name = this.constructor.name;
  }
  
  QUOTA_EXCEEDED_ERR.prototype.toString = function() {
    return this.name + ": " + this.message;
  };
  ...

module node-localstorage.QUOTA_EXCEEDED_ERR.prototype

function node-localstorage.QUOTA_EXCEEDED_ERR.prototype.constructor (message)

• description and source-code

  function QUOTA_EXCEEDED_ERR(message) {
    this.message = message != null ? message : 'Unknown error.';
    if (Error.captureStackTrace != null) {
      Error.captureStackTrace(this, this.constructor);
    }
    this.name = this.constructor.name;
  }

• example usage

  n/a

function node-localstorage.QUOTA_EXCEEDED_ERR.prototype.toString ()

• description and source-code

  toString = function () {
    return this.name + ": " + this.message;
  }

• example usage

  ...
  };
  
  _escapeKey = function(key) {
    var newKey;
    if (key === '') {
      newKey = KEY_FOR_EMPTY_STRING;
    } else {
      newKey = key.toString();
    }
    return newKey;
  };
  
  QUOTA_EXCEEDED_ERR = (function(superClass) {
    extend(QUOTA_EXCEEDED_ERR, superClass);
  ...